Skip to main content

A package to create changelogs for your git tracked projects.

Project description

install with pip

python3 -m pip install changelog-md

install with Poetry

poetry add changelog-md

execution information:

This script aim to provide changelogs on git-tracked projects. Run changelog.py script in your directory and it'll generate the changelog file. In order to obtain actual changelog, run:

You can use git changelog from command line directly:

# ... code on project
git commit                                                    #add your commit message on work you've done
python3 -m changelog_md vX.Y.Z "Annotation for this version" #generate changelog
git add changelog.md                                          #stage the changelog to current commit
git commit --amend                                            #add the changelog to current commit, leave commit message as is.
git tag -a vX.Y.Z -m "Annotation for this version"            #add the tag you've set earlier in changelog.
git push --follow-tags                                        #publish your changes and the new tag.

Or you can elaborate your workflow python scripts to use changelog_md as a python module:

# CICD_script.py
# ... do some CICD work

from changelog_md import logger
l = logger('vX.Y.Z', 'Annotation for this version')           #create logger instance
l.make()                                                      #print the log

# ... do other CICD work

More actual information on colophon of scripts:

#actual information on colophon:
python3 -m changelog_md --help

correct commit messages:

To make this scripts work properly, your commit messages should look like any of this:

[feature] feature description here
[fix] fix description
[changelog] minor changes description
[internal] this section will be generated only if --internal argument is given.
This commit message string will be ommited from changelog.

Releases:

Any tagged commit will be interpreted as release. To create tag, write:

git tag -a v<version>
... tag anotation ...
git push --follow-tags

Any commit above the last tag will be marked as tag provided in command line arguments and annotated accordingly.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

changelog_md-0.1.4.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

changelog_md-0.1.4-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file changelog_md-0.1.4.tar.gz.

File metadata

  • Download URL: changelog_md-0.1.4.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.4.0-52-generic

File hashes

Hashes for changelog_md-0.1.4.tar.gz
Algorithm Hash digest
SHA256 43581abc8695ef16dea9ad11d85a56300ec1677b5027d96a006ac0075ffaa864
MD5 009f254e31fe283650b1ea2190c97ef4
BLAKE2b-256 2087c81770267cc929ea81510ac7baceb4aacd76cb6f5dcd47a24e3f41e43283

See more details on using hashes here.

File details

Details for the file changelog_md-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: changelog_md-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.4.0-52-generic

File hashes

Hashes for changelog_md-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2c82e346ffe0f7607501ab79cf6e92fe99bf398e2c7b52a30c25ecc273f4b062
MD5 10737144b7a9a749746e3b7a287f4011
BLAKE2b-256 5259e7fec82fe2145c1ba2f2b9dde75fc9f22e2c088cf471aa30af5f646e9ffe

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page