From 48e4d9ddbbe07b2b9563426b99d60ed1ae677fcc Mon Sep 17 00:00:00 2001 From: Liam Newman Date: Sat, 25 Nov 2023 10:58:16 -0800 Subject: [PATCH 1/3] Update README.adoc with publishing instructions --- README.adoc | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.adoc b/README.adoc index a8da0e0a..2635a003 100644 --- a/README.adoc +++ b/README.adoc @@ -21,6 +21,17 @@ Doing so (as opposed to depending on `+org.kohsuke:github-api+` as a jar), we can eliminate the classloader problems caused by having multiple copies of github-api loaded. 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. +== Publishing a new release + +The major and minor version numbers of this plugin align to the version of the +https://github.com/kohsuke/github-api[github-api] library version. + +This plugin uses the standard system for publishing +https://www.jenkins.io/doc/developer/publishing/releasing-cd/#releasing[incremental Jenkins releases]. +To trigger the system to publish a new version of this plugin, add a descriptive label such as `developer` or `enhancement` +to your PR before it is merged. When the PR is merged, the system will automatically publish a new version of the plugin. +NOTE: the `dependencies`, `chore`, and `java` labels will not trigger a the publishing of a new version. + == Changelog * See link:https://github.com/jenkinsci/github-api-plugin/releases[GitHub Releases] for recent plugin versions From 244f8dbcdd5365e4136844ebcd82ceb8745d5762 Mon Sep 17 00:00:00 2001 From: Liam Newman Date: Sat, 25 Nov 2023 19:12:22 +0000 Subject: [PATCH 2/3] Add CONTRIBUTING file --- CONTRIBUTING.adoc | 10 ++++++++++ README.adoc | 13 +------------ 2 files changed, 11 insertions(+), 12 deletions(-) create mode 100644 CONTRIBUTING.adoc diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc new file mode 100644 index 00000000..7f7cff01 --- /dev/null +++ b/CONTRIBUTING.adoc @@ -0,0 +1,10 @@ += Contributing + +== Publishing a new release + +This plugin uses the standard system for publishing +https://www.jenkins.io/doc/developer/publishing/releasing-cd/#releasing[incremental Jenkins releases]. +To trigger the system to publish a new version of this plugin, add a descriptive label such as `developer` or `enhancement` +to your PR before it is merged. When the PR is merged, the system will automatically publish a new version of the plugin. + +NOTE: the `dependencies`, `chore`, and `java` labels will not trigger publishing of a new version. diff --git a/README.adoc b/README.adoc index 2635a003..51e7170c 100644 --- a/README.adoc +++ b/README.adoc @@ -16,22 +16,11 @@ There's no need to install this plugin manually, although you want to keep it up == Note to plugin developers If you are developing a plugin that depends on http://kohsuke.org/github-api[github-api], -it's is highly recommended that you depend on this as opposed to bundle the jar locally. +it's is highly recommended that you depend on this pluging as opposed to bundle the jar locally. Doing so (as opposed to depending on `+org.kohsuke:github-api+` as a jar), we can eliminate the classloader problems caused by having multiple copies of github-api loaded. 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. -== Publishing a new release - -The major and minor version numbers of this plugin align to the version of the -https://github.com/kohsuke/github-api[github-api] library version. - -This plugin uses the standard system for publishing -https://www.jenkins.io/doc/developer/publishing/releasing-cd/#releasing[incremental Jenkins releases]. -To trigger the system to publish a new version of this plugin, add a descriptive label such as `developer` or `enhancement` -to your PR before it is merged. When the PR is merged, the system will automatically publish a new version of the plugin. -NOTE: the `dependencies`, `chore`, and `java` labels will not trigger a the publishing of a new version. - == Changelog * See link:https://github.com/jenkinsci/github-api-plugin/releases[GitHub Releases] for recent plugin versions From 97ec0d77e6a5996511cbc985794cf356655b850d Mon Sep 17 00:00:00 2001 From: Liam Newman Date: Sat, 25 Nov 2023 11:14:53 -0800 Subject: [PATCH 3/3] Update README.adoc --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 51e7170c..166be8a2 100644 --- a/README.adoc +++ b/README.adoc @@ -16,7 +16,7 @@ There's no need to install this plugin manually, although you want to keep it up == Note to plugin developers If you are developing a plugin that depends on http://kohsuke.org/github-api[github-api], -it's is highly recommended that you depend on this pluging as opposed to bundle the jar locally. +it's is highly recommended that you depend on this plugin as opposed to bundle the jar locally. Doing so (as opposed to depending on `+org.kohsuke:github-api+` as a jar), we can eliminate the classloader problems caused by having multiple copies of github-api loaded. 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.