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 steps for releasing a new version in the maintainers guide #1897

Merged
merged 4 commits into from
Jul 13, 2023

Conversation

zimeg
Copy link
Member

@zimeg zimeg commented Jul 13, 2023

Summary

This PR makes slight adjustments to the steps for releasing a new version in the maintainers guide.

  • CHANGELOG.md is removed from the files to verify in the packaged contents since this file does not exist in this repo.
  • A note on which tag to use for stable releases was added for more clarity.
  • A suggestion to group related changes in the release notes was also added.

This is from some of my observations in releasing, but very open to changing any of this as needed!

Requirements

@zimeg zimeg added the docs M-T: Documentation work only label Jul 13, 2023
@zimeg zimeg added this to the 3.13.3 milestone Jul 13, 2023
@zimeg zimeg requested a review from seratch July 13, 2023 01:20
@zimeg zimeg self-assigned this Jul 13, 2023
Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

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

Looks much clearer! Thanks 👍

@codecov
Copy link

codecov bot commented Jul 13, 2023

Codecov Report

Merging #1897 (9af9dd2) into main (890cc05) will not change coverage.
The diff coverage is n/a.

❗ Current head 9af9dd2 differs from pull request most recent head 610a26d. Consider uploading reports for the commit 610a26d to get more accurate results

@@           Coverage Diff           @@
##             main    #1897   +/-   ##
=======================================
  Coverage   82.18%   82.18%           
=======================================
  Files          18       18           
  Lines        1521     1521           
  Branches      436      436           
=======================================
  Hits         1250     1250           
  Misses        175      175           
  Partials       96       96           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@zimeg zimeg merged commit 68a1171 into slackapi:main Jul 13, 2023
5 checks passed
@zimeg zimeg deleted the release-guide branch July 13, 2023 01:23
@zimeg
Copy link
Member Author

zimeg commented Jul 13, 2023

@seratch thank you! Hoping it can remove some future confusion 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only semver:patch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants