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

Describe identifiers more clearly in help and documentation #128

Merged
merged 1 commit into from
Aug 3, 2023
Merged

Describe identifiers more clearly in help and documentation #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Input Example with `Message Parameter`:
input 'Proceed or Abort'


Input Example with `Custom ID`:
Every input step has an unique ID. It is used in the generated URL to proceed or abort.
Input Example with `Custom identifier`:
Every input step has an unique identifier. It is used in the generated URL to proceed or abort.

A specific ID could be used, for example, to mechanically respond to the input from some external process/tool.
A specific identifier could be used, for example, to mechanically respond to the input from some external process/tool.

input id: '2', message: 'input-message'

Expand All @@ -23,14 +23,14 @@ Input Example with `OK Button Caption`(Optional):
input message: 'input-message', ok: 'OK'

Input Example with `Allowed Submitter`:
User IDs and/or external group names of person or people permitted to respond to the input, separated by ','. Spaces will be trimmed automatically, so "Alice, Bob, Charles" is the same as "Alice,Bob,Charles".
Usernames and/or external group names of those permitted to respond to the input, separated by ','. Spaces will be trimmed automatically, so "Alice, Bob, Charles" is the same as "Alice,Bob,Charles".
Note: Jenkins administrators are able to respond to the input regardless of the value of this parameter.

input message: '', submitter: 'jenkins-user, jenkins-user2'

Input Example with Parameter to store the `Approving Submitter`:

If specified, this is the name of the return value that will contain the ID of the user that approves this input. The return value will be handled in a fashion similar to the parameters value.
If specified, this is the name of the return value that will contain the username of the user that approves this input. The return value will be handled in a fashion similar to the parameters value.

input message: 'input-message', submitter: 'jenkins-submitter, jenkins-submitter2', submitterParameter: 'approvers-id-to-be-stored'

Expand Down
4 changes: 2 additions & 2 deletions src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-id.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p>
Every <code>input</code> step has an unique ID. It is used in the generated URL to proceed or abort.
Every <code>input</code> step has an unique identifier. It is used in the generated URL to proceed or abort.
</p>
<p>
A specific ID could be used, for example, to mechanically respond to the input from some external process/tool.
A specific identifier could be used, for example, to mechanically respond to the input from some external process/tool.
</p>