10up / action-repo-automator

GitHub Action to automate common repo operations like validate PR description, changelog, and credits.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Release version 1.0.0

iamdharmesh opened this issue · comments

This issue is for tracking changes for the 1.0.0 release. Target release date: Oct 2022.

Pre-release steps

  • Complete review of PR #16, resolve issues and merge

Release instructions

  • Branch: Starting from develop, cut a release branch named release/1.0.0 for your changes.
  • Version bump: Bump the version number in package.json, package-lock.json and any other relevant files if it does not already reflect the version being released.
  • Changelog: Add/update the changelog in CHANGELOG.md.
  • Props: update CREDITS.md file with any new contributors, confirm maintainers are accurate.
  • New files: Check to be sure any new files/paths that are unnecessary in the production version are included in .gitattributes.
  • Readme updates: Make any other readme changes as necessary.
  • Merge: Make a non-fast-forward merge from your release branch to develop (or merge the pull request), then do the same for develop into trunk (git checkout trunk && git merge --no-ff develop). trunk contains the stable development version.
  • Push: Push your trunk branch to GitHub (e.g. git push origin trunk).
  • Release: Create a new release, naming the tag and the release with the new version number, and targeting the trunk branch. Paste the changelog from CHANGELOG.md into the body of the release and include a link to the closed issues on the milestone.
  • Close milestone: Edit the milestone with release date (in the Due date (optional) field) and link to GitHub release (in the Description field), then close the milestone.
  • Punt incomplete items: If any open issues or PRs which were milestoned for 1.0.0 do not make it into the release, update their milestone to 1.1.0 or Future Release.