Skip to content

Instantly share code, notes, and snippets.

@kumlali

kumlali/Release_process_of_GitHub_projects.md

Last active March 21, 2018 12:11
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save kumlali/70bc2f8060cd376fbd0b397d11e2f3bc to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save kumlali/70bc2f8060cd376fbd0b397d11e2f3bc to your computer and use it in GitHub Desktop.
Download ZIP
Release process of GitHub projects
Raw
Release_process_of_GitHub_projects.md

Release process of GitHub projects

When the code is ready to be released:

  • Add change log to CHANGELOG.md
  • Commit and push it to GitHub
  • Create release tag(e.g. 1.1) by providing changes added to CHANGELOG.md:
    • Create tag.md file and copy target release changes from CHANGELOG.md.
    • git tag -F tag.md 1.1
    • git push --tags
  • Visit the tag's page in GitHub
  • Choose "Add release notes"
  • Enter the tag name into "Release title" (e.g. 1.1)
  • Enter the content of tag.md into "Describe this release". Preview it to last check.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment