From a6a74c29af3f8e569cf8bab6479481e9328e666c Mon Sep 17 00:00:00 2001 From: Nick Floyd <139819+nickfloyd@users.noreply.github.com> Date: Mon, 31 Oct 2022 12:39:00 -0500 Subject: [PATCH] Removes references to old labels and updates release steps (#2601) --- .github/workflows/stale.yml | 4 +-- CONTRIBUTING.md | 2 +- DEPLOYMENT.md | 49 ++++--------------------------------- 3 files changed, 8 insertions(+), 47 deletions(-) diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index b8115b1e02..cfd0143c32 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -14,12 +14,12 @@ jobs: stale-issue-message: > 👋 Hey Friends, this issue has been automatically marked as `stale` because it has no recent activity. It will be closed if no further activity occurs. - Please add the `pinned` label if you feel that this issue needs to remain open/active. + Please add the `Status: Pinned` label if you feel that this issue needs to remain open/active. Thank you for your contributions and help in keeping things tidy! stale-pr-message: > 👋 Hey Friends, this pull request has been automatically marked as `stale` because it has no recent activity. It will be closed if no further activity occurs. - Please add the `pinned` label if you feel that this issue needs to remain open/active. + Please add the `Status: Pinned` label if you feel that this issue needs to remain open/active. Thank you for your contributions and help in keeping things tidy! days-before-stale: 270 days-before-close: 7 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b948f5020..512fdc506b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ to ensure everything builds and the tests pass. ## How can I get involved? -We have an [`up-for-grabs`](https://github.com/octokit/octokit.net/labels/up-for-grabs) +We have an [`Status: Up for grabs`](https://github.com/octokit/octokit.net/labels/Status%3A%20Up%20for%20grabs) tag on our issue tracker to indicate tasks which contributors can pick up. If you've found something you'd like to contribute to, leave a comment in the issue diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md index adb084c1b9..1d8de296ad 100644 --- a/DEPLOYMENT.md +++ b/DEPLOYMENT.md @@ -5,52 +5,13 @@ Creating a new release and deploying the package to nuget are administrative tasks and require that you have/do the following: 1. Admin access to the [GitHub](https://www.nuget.org/profiles/GitHub) NuGet organization 2. Admin rights to the [octokit.net](https://github.com/octokit/octokit.net) repository -3. For any PRs that should be noted in the release notes, each pull request must have a comment formatted like `release_notes: description` where description represents the details of the change. ### Publish to nuget.org 1. Run test and perform manual tests from `main` -2. [Generate](https://github.com/shiftkey/octokit.releasenotes) the release notes. `Octokit.ReleaseNotes generate main [LAST RELEASE TAG]` (i.e. `dotnet run generate main v3.0.0`) -3. When you're satisfied with this release, create a tag `git tag v#.#.#`. For example, to create a tag for 3.0.1 +2. When you're satisfied with this release, create a tag `git tag v#.#.#`. For example, to create a tag for 3.0.1 `git tag v3.0.1` -4. Push the tag to the server. `git push --tags` -5. When the tag is successfully pushed, the [publish workflow](https://github.com/octokit/octokit.net/blob/main/.github/workflows/publish.yml) will run and build and push the package to nuget -6. Verify that the package has been uploaded to [nuget.org](https://www.nuget.org/packages/Octokit/) -7. Create a [new release](https://github.com/octokit/octokit.net/releases/new) using the tag you just created and pasting in the release notes you just generated - ---- - -### Release notes generator - -Release notes [generator](https://github.com/shiftkey/octokit.releasenotes): this is used to pull details using the GitHub API to generate the release notes. - -The generator helps in that it produces release notes that are consistently formatted based on information directly from the change scope (from the previous release to the current tip i.e. the `release` branch). - -Any PRs that should be noted in the release notes, each pull request must have a comment formatted like `release_notes: description` where description represents the details of the change. Make sure for the commit range any changeset in a PR that should be represented has a comment on the PR prefixed with `release_notes:` and corresponding label. - -The nuances are mostly around how it gets and parses release notes from the PRs found in the changeset. The following are the comment prefixes that the generator currently supports: - -* `release_notes` - Having this in the comment with a corresponding "category" label on the PR will put the given note under the "Release Notes" section of the output in the group for the given label -* `advisories` - Having this in the comment will put the given note into the "Advisories and Breaking Changes" section of the output - -In addition to formatted comment parsing, the generator also looks at the following labels to generate categories with in the release notes. - -* `category: bug` - This will add the comment in the PR prefixed with `release_notes` into the `Fixes` group -* `category: docs-and-samples` - This will add the comment in the PR prefixed with `release_notes` into the `Documentation Updates` group -* `category: feature` - This will add the comment in the PR prefixed with `release_notes` into the `Features/Enhancements` group -* `category: housekeeping` - This will add the comment in the PR prefixed with `release_notes` into the `Housekeeping` group - -When these labels are added to a given PR the generator will produce and categorize comment in the release notes formatted like: - -`Comment content` - `PR Id and link` via `Contributor` -ex. "Cleans up some mentions of `master` branch in codebase - [#2306](https://github.com/octokit/octokit.net/pull/2306) via [@shiftkey](https://github.com/shiftkey)" - ----- -### Troubleshooting - -When running the release notes generator on a mac if dotnet has not been added to the PATH or there is not alias defined in your dotfiles you'll need to execute the command as follows: - -`dotnet run generate [BASE] [HEAD]` -(where `[BASE]` is the last release label (i.e. v0.50.0) and `[HEAD]` represents the `release` branch tip that was generated above) - -The tool looks for a environment variable named `OCTOKIT_OAUTHTOKEN`. This token requires a minimal scope to execute and pull the data from the repository via API. Keep in mind that if a token is not provided then you will most likely run into rate limit errors because the requests are being made anonymously. +3. Push the tag to the server. `git push --tags` +4. When the tag is successfully pushed, the [publish workflow](https://github.com/octokit/octokit.net/blob/main/.github/workflows/publish.yml) will run and build and push the package to nuget +5. Verify that the package has been uploaded to [nuget.org](https://www.nuget.org/packages/Octokit/) +6. Create a [new release](https://github.com/octokit/octokit.net/releases/new) using the tag you just created and pasting in the release notes you just generated