Skip to content

Commit 244f8db

Browse files
committed
Add CONTRIBUTING file
1 parent 48e4d9d commit 244f8db

2 files changed

Lines changed: 11 additions & 12 deletions

File tree

CONTRIBUTING.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
= Contributing
2+
3+
== Publishing a new release
4+
5+
This plugin uses the standard system for publishing
6+
https://www.jenkins.io/doc/developer/publishing/releasing-cd/#releasing[incremental Jenkins releases].
7+
To trigger the system to publish a new version of this plugin, add a descriptive label such as `developer` or `enhancement`
8+
to your PR before it is merged. When the PR is merged, the system will automatically publish a new version of the plugin.
9+
10+
NOTE: the `dependencies`, `chore`, and `java` labels will not trigger publishing of a new version.

README.adoc

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,11 @@ There's no need to install this plugin manually, although you want to keep it up
1616
== Note to plugin developers
1717

1818
If you are developing a plugin that depends on http://kohsuke.org/github-api[github-api],
19-
it's is highly recommended that you depend on this as opposed to bundle the jar locally.
19+
it's is highly recommended that you depend on this pluging as opposed to bundle the jar locally.
2020
Doing so (as opposed to depending on `+org.kohsuke:github-api+` as a jar),
2121
we can eliminate the classloader problems caused by having multiple copies of github-api loaded.
2222
Specifically, if plugin A and B both locally includes its own copy of the `+github-api.jar+` and another plugin C depends on A and B, it'll break.
2323

24-
== Publishing a new release
25-
26-
The major and minor version numbers of this plugin align to the version of the
27-
https://github.com/kohsuke/github-api[github-api] library version.
28-
29-
This plugin uses the standard system for publishing
30-
https://www.jenkins.io/doc/developer/publishing/releasing-cd/#releasing[incremental Jenkins releases].
31-
To trigger the system to publish a new version of this plugin, add a descriptive label such as `developer` or `enhancement`
32-
to your PR before it is merged. When the PR is merged, the system will automatically publish a new version of the plugin.
33-
NOTE: the `dependencies`, `chore`, and `java` labels will not trigger a the publishing of a new version.
34-
3524
== Changelog
3625

3726
* See link:https://github.com/jenkinsci/github-api-plugin/releases[GitHub Releases] for recent plugin versions

0 commit comments

Comments
 (0)