Gitch takes entries from your CHANGELOG.md, and converts them into
Github releases.
How you create your changelog is of no interest to gitch.
]$ pip install gitch
You will first need to create a github personal access token.
You will need to give your access token repo scope.
Then, tell gitch about it like so:
]$ export GITCH_GITHUB_TOKEN=<token>
Consider a CHANGELOG.md like so:
# Changelog
## v2.60.1 (2020-05-23)
**Merged pull requests:**
- did a thing to a thing.
## v2.60.0 (2020-05-12)
**Closed issues:**
- fixed some other thing that was fooing too much.
The gitch tool will assume that the first token in each H2 header identifies
a tag in your github repository (in the example above, these are v2.60.1 and
v2.60.0). It will then simply create github releases that match these tags. The
actual content within each tag section is copied verbatim into the release notes.
Note that releases will not be created unless the matching tag exists at the remote (ie on github). This is to avoid typos in your changelog creating spurious tags in your repository.
]$ gitch --all
gitch INFO Syncing 'v2.60.1' to github...
gitch INFO 'v2.60.1' synced, see https://github.com/jbloggs/foo/releases/tag/v2.60.1
gitch INFO Syncing 'v2.60.0' to github...
gitch WARNING Tag 'v2.60.0' does not exist at the remote
1 changelog entries pushed to github
To list the entries (ie tags) present in your changelog:
]$ gitch -l
To sync the latest changelog entry to github releases:
]$ gitch
To sync a specific changelog entry to github releases:
]$ gitch <tag>
To overwrite a github release (this does not happen by default):
]$ gitch <tag> --overwrite
To sync an entire changelog to github (ie create all associated releases):
]$ gitch --all