docs: add documentation for releasing on a Jenkins instance (#324)

python-semantic-release · Feb 17, 2021 · 77ad988 · 77ad988
1 parent 9185616
commit 77ad988
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/automatic-releases/index.rst b/docs/automatic-releases/index.rst
@@ -54,6 +54,15 @@ Checks for gitlab-ci to ensure that the build is on the correct branch.
 The branch check, checks against the branch that gitlab-ci said it checked out, not the current
 branch.
 
+Jenkins
+^^^^^^^
+*Condition:* Environment variable ``JENKINS_URL`` is set.
+
+Determines the branch name from either the environment variable ``BRANCH_NAME``
+or the environment variable ``GIT_BRANCH``, and checks to ensure that the build is on
+the correct branch. Also, if ``CHANGE_ID`` is set, meaning it is a PR from a multi-branch
+pipeline, the build will not be automatically released.
+
 Publish with CI
 ~~~~~~~~~~~~~~~
 Add ``python setup.py publish`` or ``semantic-release publish`` as an after success task on your

diff --git a/docs/envvars.rst b/docs/envvars.rst
@@ -46,6 +46,12 @@ Used to check if this is a Travis CI environment.
 -------------
 Used to check if this is a GitLab CI environment.
 
+.. _env-jenkins_url:
+
+``JENKINS_URL``
+---------------
+Used to check if this is a Jenkins CI environment.
+
 ``CI_SERVER_HOST``
 ------------------
 Host component of the GitLab instance URL, without protocol and port.