Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CONTRIBUTING.md: Add some information to package the plugin #581

Merged
merged 2 commits into from
Feb 4, 2025

Conversation

panicking
Copy link
Contributor

Add some basic steps to explain how to package the plugin

Testing done

Deploy the package to upload to jenkins present in our infrastructure

@panicking panicking requested a review from a team as a code owner February 4, 2025 20:03
Copy link
Member

@timja timja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this would be a bit better

CONTRIBUTING.md Outdated

To generate the hpi package and run the test you can use two different maven command
```sh
mvn -U package
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
mvn -U package
mvn package

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

CONTRIBUTING.md Outdated
Comment on lines 88 to 91
This command will build the package that you can find in target directory and run the tests
otherwise just run
```sh
mvn -U -DskipTests=true package
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This command will build the package that you can find in target directory and run the tests
otherwise just run
```sh
mvn -U -DskipTests=true package
```
For a quicker build without the tests run:
```sh
mvn package -P quick-build

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

CONTRIBUTING.md Outdated
@@ -79,6 +79,18 @@ npm run build:dev

It's recommended that you set up the above terminal commands in your IDE of choice.

### Package and run test
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Package and run test
### Build and package

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@panicking panicking force-pushed the add-package-documentation branch 2 times, most recently from 8e21a4f to 3362b17 Compare February 4, 2025 22:20
Signed-off-by: Michael Trimarchi <michael@amarulasolutions.com>
@panicking panicking force-pushed the add-package-documentation branch from 3362b17 to fb88a66 Compare February 4, 2025 22:22
@timja timja added the documentation A PR that adds to documentation - used by Release Drafter label Feb 4, 2025
@timja timja enabled auto-merge (squash) February 4, 2025 22:31
@timja timja merged commit 2dbb349 into jenkinsci:main Feb 4, 2025
17 checks passed
@panicking panicking deleted the add-package-documentation branch February 5, 2025 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation A PR that adds to documentation - used by Release Drafter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants