-
Notifications
You must be signed in to change notification settings - Fork 72
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.
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
[JENKINS-65338]- Add snippet generator hint to build step help #51
Conversation
Triggers a new build for a given job. | ||
</p> | ||
<p> | ||
Use the <a href="https://www.jenkins.io/redirect/pipeline-snippet-generator">Pipeline Snippet Generator</a> to generate a sample pipeline script for the build step. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be better to link it to the snippet generator itself instead of its docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will it work to link to the snippet generator? This page is included in both the online help inside Jenkins and the Pipeline steps reference. I assumed that a link to the snippet generator inside Jenkins would result in broken link complaints from readers of the Pipeline steps reference.
Then we should probably implement conditional logic which will show
different links depending on the target environment. It could be done via
environment variable or system property, and it could be a great
enhancement for other docs
…On Sat, Apr 10, 2021, 13:12 Mark Waite ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In
src/main/resources/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep/help.html
<#51 (comment)>
:
> @@ -1,3 +1,8 @@
<div>
- Triggers a new build for a given job.
+ <p>
+ Triggers a new build for a given job.
+ </p>
+ <p>
+ Use the <a href="https://www.jenkins.io/redirect/pipeline-snippet-generator">Pipeline Snippet Generator</a> to generate a sample pipeline script for the build step.
Will it work to link to the snippet generator? This page is included in
both the online help inside Jenkins and the Pipeline steps reference
<https://www.jenkins.io/doc/pipeline/steps/pipeline-build-step/>. I
assumed that a link to the snippet generator inside Jenkins would result in
broken link complaints from readers of the Pipeline steps reference.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#51 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAW4RICHGUEVIGBRBE7OOR3TIAXAVANCNFSM42WDCOEA>
.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No objections w.r.t merging as is. Too late to address the comment about the Snippet generator. For the future, it would be nice to timely get a response from the PR author
...main/resources/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep/help.html
Outdated
Show resolved
Hide resolved
…s/build/BuildTriggerStep/help.html Co-authored-by: Ramon Leon <manuelramonleonjimenez@gmail.com>
Make sure you are opening from a topic/feature/bugfix branch (right side) and not your master branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Added snippet generator hint to build step help
Link to relevant issues in GitHub or Jira
JENKINS-65338
Hello @MarkEWaite @oleg-nenashev @kwhetstone @StackScribe, please kindly review.