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.

Sign up for GitHub

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

Jump to bottom

[JENKINS-71876] Add "NOTIFY_COMMIT_ACCESS_CONTROL" examples #1641

Merged
merged 10 commits into from
Aug 21, 2024
Merged

[JENKINS-71876] Add "NOTIFY_COMMIT_ACCESS_CONTROL" examples #1641

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
00e2ec3
Update documentation for setting NOTIFY_COMMIT_ACCESS_CONTROL system …
sirine707 Aug 20, 2024
cff0e47
fixed spacing
sirine707 Aug 20, 2024
a0d77b1
Merge branch 'jenkinsci:master' into update-notifyCommit-docs
sirine707 Aug 20, 2024
9c5f636
Updated README file
sirine707 Aug 20, 2024
633c7d3
Remove GitPod configuration
MarkEWaite Aug 21, 2024
878f1b1
Use disabled-for-polling in examples
MarkEWaite Aug 21, 2024
c65a066
Add prefix text for system property
MarkEWaite Aug 21, 2024
435ca6d
Retain indentation for code fragment
MarkEWaite Aug 21, 2024
21d3b0e
Remove groovy specific formatting from example
MarkEWaite Aug 21, 2024
3399e39
Move return value description earlier
MarkEWaite Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,8 @@ If polling finds a change worthy of a build, a build will be triggered.
This allows a notify script to remain the same for all Jenkins jobs.
Or if you have multiple repositories under a single repository host application (such as Gitosis), you can share a single post-receive hook script with all the repositories.

When notifyCommit is successful, the list of triggered projects is returned.

The `token` parameter is required by default as a security measure, but can be disabled by the following link:https://www.jenkins.io/doc/book/managing/system-properties/[system property]:

....
Expand All @@ -337,7 +339,27 @@ It has two modes:
* `disabled` - Fully disables the access token mechanism and allows all requests to `notifyCommit`
to be unauthenticated. *This option is insecure and is not recommended.*

When notifyCommit is successful, the list of triggered projects is returned.
You can set the `NOTIFY_COMMIT_ACCESS_CONTROL` value with either a link:https://www.jenkins.io/doc/book/managing/system-properties/[system property] or a link:https://www.jenkins.io/doc/book/managing/groovy-hook-scripts/[Groovy hook script].

[[using-a-system-property-push-notification]]
Using a system property::

The `NOTIFY_COMMIT_ACCESS_CONTROL` value can be set from the command line that starts Jenkins.
This method is useful for environments where initial Jenkins settings are managed with command line arguments.
+
....
java -Dhudson.plugins.git.GitStatus.NOTIFY_COMMIT_ACCESS_CONTROL=disabled-for-polling -jar jenkins.war
....

[[using-a-groovy-script-push-notification]]
Using a Groovy script::

The `NOTIFY_COMMIT_ACCESS_CONTROL` value can be set using a Groovy script placed in the `init.groovy.d` subdirectory of the Jenkins home directory.
This method is useful for environments where Jenkins settings are managed with link:https://www.jenkins.io/doc/book/managing/groovy-hook-scripts/#post-initialization-script-init-hook[Groovy post-initialization scripts].
+
----
hudson.plugins.git.GitStatus.NOTIFY_COMMIT_ACCESS_CONTROL='disabled-for-polling'
----

[#enabling-jgit]
=== Enabling JGit
Expand Down
Loading