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.

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

Update Jenkins changelogs to always show a pull request link #2916

Open
oleg-nenashev opened this issue Mar 3, 2020 · 3 comments
Open

Update Jenkins changelogs to always show a pull request link #2916

oleg-nenashev opened this issue Mar 3, 2020 · 3 comments
Labels
changelog Jenkins changelogs enhancement

Comments

@oleg-nenashev
Copy link
Contributor

In the Jenkins pull requests we set a pretty high standard in terms of what goes to pull requests. We expect PR summaries to summarize changes, provide screenshots and upgrade guidelines if necessary. This information would be a good addition for advanced users, especially the upgrade guidelines part which is missing in LTS now... It could also encourage Jenkins users to participate in the discussions and, maybe, to submit their own pull requests.

Examples of pull requests where Jenkins users can benefit from PR links:

WDYT @MarkEWaite @daniel-beck @timja @res0nance?

@oleg-nenashev oleg-nenashev added enhancement changelog Jenkins changelogs labels Mar 3, 2020
@res0nance
Copy link
Contributor

I think the idea is good although we might not want everything? Perhaps this idea could be trialed. For UI changes the screenshots offer a lot to the user to be able to see the new UI. But for Developer level changes it might not offer as much to an end-user

@daniel-beck
Copy link
Contributor

Hiding the PR URL when there's a Jira issue was a deliberate choice for multiple reasons:

  • Pull requests are an implementation detail. If we need them to explain a change, then we're doing the changelog wrong and should rather work some more on that, or the Jira issue (or require a Jira issue in the first place).
  • I have absolutely no interest in having users (i.e. people with no intention to actually contribute, or to even spend a second to look at tags etc. to understand what is even the current status) comment on pull requests. See Winstone backport PR, auto refresh PR, or sidebar truncation PR. None of these comments were useful.

@oleg-nenashev
Copy link
Contributor Author

FTR #2917 is likely a better and less controversial solution for upgrade guidelines

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog Jenkins changelogs enhancement
Projects
None yet
Development

No branches or pull requests

3 participants