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

Create and automate Release notes #149

Open
abergs opened this issue Mar 24, 2020 · 2 comments
Open

Create and automate Release notes #149

abergs opened this issue Mar 24, 2020 · 2 comments
Labels
help wanted Extra attention is needed

Comments

@abergs
Copy link
Collaborator

abergs commented Mar 24, 2020

Since we now have a stable version of Fido2 published we need to maintain release notes to help developers upgrade.

  • Automate as much as possible (releases are currently done with scripts/run-all.ps1
  • Add information to nupkg release notes
  • Add information to GitHub Releases
  • Git tag support?
@abergs abergs added the help wanted Extra attention is needed label Mar 24, 2020
@abergs
Copy link
Collaborator Author

abergs commented May 27, 2020

I believe this Task could be helpful, will explore: https://devblogs.microsoft.com/devops/automating-releases-in-github-through-azure-pipelines/

@abergs
Copy link
Collaborator Author

abergs commented May 28, 2020

Alright, successfully added Release Drafter (https://github.com/marketplace/actions/release-drafter) which generates a draft release for every merge on the repo, result looks like this (see below). It also have good support for categories such as bug fixes/features depending on labels on the PR.

So current flow is:

  • Manually bump version numbers (using Scripts/setVersion.ps1).
  • Create PR with perhaps discussion regarding Major.Minor.Patch, sharing the Draft Release notes.
  • Merge PR. Publish Release notes.
  • Checkout tag, run Scripts/run-all.ps1 to build, setVersion and push to nuget.

Could be improved to:

  • Semi-Manually (script) bump version number, Create PR where Release Notes and version can be discussed and changed.
  • Merge PR, automatically publishes release notes, builds and pushes to nuget.

Draft PR:
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant