Release exporter for GitHub and GitLab.
Project description
Release Exporter
Exports your releases to a markdown based on keep a changelog and markdownlint. This CLI application currently supports GitHub and GitLab.
Install
pip install release-exporter
Or download this repository and type in the following in your terminal/cmd
python setup.py install
Usage
In your terminal/cmd, change to the folder where you repository is located and do the following:
rex --token <your token> markdown
That’s it. You should see a CHANGELOG.md in your folder.
Advance Usage
Release exporter has the following options
Usage: rex [OPTIONS] COMMAND [ARGS]...
Options:
--token TEXT Token number if its a private repository.
--url TEXT URL of your repository. This is optional if your current
directory has .git folder with remote url.
--location TEXT Local location of your repository.
--version
--help Show this message and exit.
Commands:
json Creates JSON file.
markdown Creates markdown file.
If you don’t have a repository on your computer but you still want to generate a change log you can manually add your repository URL as following:
rex markdown --token <your token> --url <your url>
if you want to save it in a custom location you can use --location <location>.
You can also export your releases to JSON file by just replacing markdown with json.
Customising the Output
Coming soon.
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
Unreleased
1.0.3 - 2018-01-16
Changed
v removed from the version number
pypandoc usage removed and *.rst format added
Unwanted encoding removed
1.0.2 - 2018-01-16
Added
Long description and changelog added to setup.py
Fixed
Typo
Exception error type changed to ImportError
v1.0.1 - 2018-01-16
Added
Unreleased tag added to the template and GitHub
Unreleased tag added to GitHub
Fixed
Tag missing in GitHub JSON fixed
Tag missing in GitLab JSON fixed
v1.0 - 2018-01-15
Initial release.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for release_exporter-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00ce7851a3e80305b54ef3df79904d050e447de988e6e888f3d30249d2b181ed |
|
MD5 | 8b8d956a26b9c919c0cc91804c947b0c |
|
BLAKE2b-256 | 53e48520c3075c5a3e862b4811e25fccd7a23bde0256ac48e285d0a6ab2c5925 |