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

Add at-since annotations up to 2.279 #5276

Merged
merged 1 commit into from
Feb 23, 2021

Conversation

daniel-beck
Copy link
Member

@daniel-beck daniel-beck commented Feb 9, 2021

This notes additions from the following pull requests or commits:

Proposed changelog entries

(Irrelevant)

Proposed upgrade guidelines

N/A

Submitter checklist

  • (If applicable) Jira issue is well described
  • Changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developer, depending on the change). Examples
    • Fill-in the Proposed changelog entries section only if there are breaking changes or other changes which may require extra steps from users during the upgrade
  • Appropriate autotests or explanation to why this change has no tests
  • For dependency updates: links to external changelogs and, if possible, full diffs

Desired reviewers

@mention

Maintainer checklist

Before the changes are marked as ready-for-merge:

  • There are at least 2 approvals for the pull request and no outstanding requests for change
  • Conversations in the pull request are over OR it is explicit that a reviewer does not block the change
  • Changelog entries in the PR title and/or Proposed changelog entries are correct
  • Proper changelog labels are set so that the changelog can be generated automatically
  • If the change needs additional upgrade steps from users, upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the PR title. (example)
  • If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).

@@ -124,7 +124,7 @@ public SetupWizard() {
*
* If you do not provide any value to that system property, the default admin account will not have an API Token.
*
* @since TODO (for the existence of the sysprop, not the availability to plugin)
* @since 2.260 (with NoExternalUse)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I rephrased this one because it seemed ambiguous/unclear to me as it was before.

@@ -3903,7 +3903,7 @@ public synchronized HttpRedirect doQuietDown() {
*
* @param block Block until the system really quiets down and no builds are running
* @param timeout If non-zero, only block up to the specified number of milliseconds
* @deprecated since TODO; use {@link #doQuietDown(boolean, int, String)} instead.
* @deprecated since 2.267; use {@link #doQuietDown(boolean, int, String)} instead.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't generally note when something was deprecated, but it was in the original so I just filled in the version.

@@ -29,7 +29,7 @@
/**
* Contains information about the token and the secret value.
* It should not be stored as is, but just displayed once to the user and then forget about it.
* @since TODO
* @since This was added in 2.260 but marked NoExternalUse, opened as Beta in 2.265
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was unclear to me which of the version numbers is relevant here, so went into more detail for clarity.

@batmat
Copy link
Member

batmat commented Feb 9, 2021

Thanks Daniel!

Out of curiosity, did you use the ./update-since-todo.sh script I had added, or did you do this manually?
I'm happy to try and improve the script if this does not work :-)

@daniel-beck
Copy link
Member Author

@batmat I've been a happy long-time user of your script 😉 I used it to identify locations and insert versions. I then manually looked up the commits and PRs to be able to reference them.

A deduplicated list of commit URLs written to stdout (any competent shell has one-click URL opening) would be a very useful addition, PRs are trivial to get from there. Looking at commits also helps ensure the generated versions are correct (#5276 (comment) would not have been). If you want to be fancy, group by version number.

@daniel-beck daniel-beck added the skip-changelog Should not be shown in the changelog label Feb 10, 2021
@daniel-beck
Copy link
Member Author

A deduplicated list of commit URLs written to stdout (any competent shell has one-click URL opening) would be a very useful addition, PRs are trivial to get from there. Looking at commits also helps ensure the generated versions are correct (#5276 (comment) would not have been). If you want to be fancy, group by version number.

Implemented in #5278

@timja timja requested a review from a team February 21, 2021 20:34
@timja timja added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Feb 21, 2021
@timja
Copy link
Member

timja commented Feb 21, 2021

This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

@timja timja merged commit 90f2d5e into jenkinsci:master Feb 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback skip-changelog Should not be shown in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants