Docs for releasing new versions

octokit / go-sdk

A generated Go SDK from GitHub's OpenAPI specification. Built on Kiota.

MIT License

64 stars 6 forks source link

Docs for releasing new versions #44

Closed kfcampbell closed 7 months ago

kfcampbell commented 7 months ago

This small PR adds docs on how to appropriately release new versions of this project. Some questions:

I've chosen to add this content to the README. Should it be in its own file?
Should this be in a different part or order of the README?
What's missing/should be changed?

:eyes: Rendered version :eyes:

Once the general approach here is OK'd, I'll make a similar PR to octokit/dotnet-sdk.

what-the-diff[bot] commented 7 months ago

PR Summary

Project Release Section Added This update adds a new section that provides a comprehensive guide on how to release the project. This includes instructions on analyzing differences between versions, determining proper version number increments, how to update the PR title, how to tag your release, and how to edit the release notes. This addition aims to enhance the project's release process, ensuring systematic and consistent roll-outs.

github-actions[bot] commented 7 months ago

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀