From 66bc8509e39fd8f990cb14a32fcd9b23f48bf18a Mon Sep 17 00:00:00 2001 From: drewcassidy Date: Fri, 7 May 2021 14:52:28 -0700 Subject: [PATCH] Version 1.0.0 ### Changed - API changes: - `header` attribute renamed to `preamble` to avoid confusion. - improved version header parsing to be more robust and handle multi-word version names. - improved version number incrementing in `release`. - can now handle other text surrounding a pep440-compliant version number, which will not be modified - can now handle pre-releases correctly. The version to increment is the most recent version in the log with a valid pep440 version number in it. - Release increment and prerelease increments can be mixed, allowing e.g: `yaclog release -mr` to create a release candidate with in incremented minor version number. - `release` base version is now an argument instead of an option, for consistency with other commands. ### Removed - `entry` with multiple `-b` options no longer add sub bullet points, instead adding each bullet as its own line. ### Added - Terminal output has color to distinguish version names/headers, sections, and git information. - Extra newlines are added between versions to improve readability of the raw markdown file. --- .github/workflows/python-publish.yml | 2 +- CHANGELOG.md | 2 +- README.md | 7 ++++++- docs/index.md | 6 +++++- setup.cfg | 3 ++- 5 files changed, 15 insertions(+), 5 deletions(-) diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml index e540ca9..f4feb95 100644 --- a/.github/workflows/python-publish.yml +++ b/.github/workflows/python-publish.yml @@ -1,7 +1,7 @@ # This workflow will upload a Python Package using Twine when a release is created # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries -name: Upload Python Package +name: build on: [ push, pull_request ] jobs: diff --git a/CHANGELOG.md b/CHANGELOG.md index b1660da..a97829f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ All notable changes to this project will be documented in this file -## Unreleased +## 1.0.0 - 2021-05-07 ### Changed diff --git a/README.md b/README.md index 8bbe7ee..05b02e0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ -# Yaclog +# Yaclog + +[![Documentation Status](https://readthedocs.org/projects/yaclog/badge/?version=latest)](https://yaclog.readthedocs.io/en/latest/?badge=latest) +[![Build Status](https://github.com/drewcassidy/yaclog/actions/workflows/python-publish.yml/badge.svg)](https://github.com/drewcassidy/yaclog/actions/workflows/python-publish.yml) +[![PyPI version](https://badge.fury.io/py/yaclog.svg)](https://badge.fury.io/py/yaclog) + Yet another changelog command line tool ![a yak who is a log](https://github.com/drewcassidy/yaclog/raw/main/logo.png) diff --git a/docs/index.md b/docs/index.md index 4b73142..c272fc2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,8 @@ -# Yaclog: Yet Another Command Line Changelog Tool +# Yaclog: Yet Another Commandline Changelog Tool + +[![Documentation Status](https://readthedocs.org/projects/yaclog/badge/?version=latest)](https://yaclog.readthedocs.io/en/latest/?badge=latest) +[![Build Status](https://github.com/drewcassidy/yaclog/actions/workflows/python-publish.yml/badge.svg)](https://github.com/drewcassidy/yaclog/actions/workflows/python-publish.yml) +[![PyPI version](https://badge.fury.io/py/yaclog.svg)](https://badge.fury.io/py/yaclog) Yaclog is a python library and command line tool to make it easier to keep track of changes to your projects. It includes commands for appending new changes to a markdown changelog file, as well as releasing new versions diff --git a/setup.cfg b/setup.cfg index 55159cf..2d57301 100644 --- a/setup.cfg +++ b/setup.cfg @@ -10,7 +10,7 @@ long_description_content_type = text/markdown keywords = changelog, commandline, markdown classifiers = - Development Status :: 4 - Beta + Development Status :: 5 - Production/Stable Intended Audience :: Developers License :: OSI Approved :: GNU Affero General Public License v3 Operating System :: OS Independent @@ -25,6 +25,7 @@ classifiers = project_urls = Source = https://github.com/drewcassidy/yaclog Changelog = https://github.com/drewcassidy/yaclog/blob/main/CHANGELOG.md + Docs = https://yaclog.readthedocs.io/ [options] install_requires =