Skip to content

Commit

Permalink
Documented changelog process a bit better
Browse files Browse the repository at this point in the history
  • Loading branch information
futurechimp committed Mar 23, 2020
1 parent b9143eb commit ef062e1
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions scripts/generate_changelog.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
#!/bin/bash
# set CHANGELOG_GITHUB_TOKEN in your .bashrc file
# For each version, you can add a release summary with text, images, gif animations, etc, and show new features and notes clearly to the user. This is done using GitHub metadata.

# Example: adding the release summary for v1.0.0:

# 1. Create a new GitHub Issue
# 2. In the Issue's Description field, add your release summary content
# 3. Set the Issue Label `release-summary` and add it to the GitHub Milestone `v1.0.0`
# 4. Close the Issue and execute `github-changelog-generator`
github_changelog_generator -u nymtech -p nym --exclude-tags 0.1.0 --token "$CHANGELOG_GITHUB_TOKEN"

0 comments on commit ef062e1

Please sign in to comment.