Merge pull request #14 from sarnold/version-bump

tool/action version upgrades

.github/workflows/main.yml

@@ -25,7 +25,7 @@ jobs:
       # To use this repository's private action,
       # you must check out the repository
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
@@ -44,7 +44,7 @@ jobs:
           [[ -z $TAG ]] || git tag --delete $TAG
 
       - name: gitchangelog action step (debug)
-        uses: ./ # Uses an action in the root directory
+        uses: ./  # Uses an action in the root directory
         with:
           github_token: ${{ secrets.GITHUB_TOKEN}}
 
@@ -62,7 +62,7 @@ jobs:
           fi
 
       - name: Checkout test repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: sarnold/gitchangelog
           path: vendor/gcl-test

.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
       # To use this repository's private action,
       # you must check out the repository
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
@@ -53,8 +53,9 @@ jobs:
           fi
 
       - name: Create release
+        if: "!startsWith(github.event.ref, 'refs/tags/v')"
         id: create_release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@master
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

.pre-commit-config.yaml

@@ -0,0 +1,41 @@
+# To install the git pre-commit hook run:
+#   pre-commit install
+# To update the pre-commit hooks run:
+#   pre-commit install-hooks
+# exclude: '^(.tox/|.*\.sh$)'
+repos:
+  - repo: meta
+    hooks:
+      - id: check-useless-excludes
+      - id: check-hooks-apply
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [--fix=lf]
+      # - id: check-json
+      - id: check-yaml
+        exclude: '.pep8speaks.yml'
+
+  - repo: https://github.com/PyCQA/doc8
+    rev: v1.0.0
+    hooks:
+      - id: doc8
+        args:
+          - '--max-line-length=90'
+          - '--ignore=D001'
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.9.0
+    hooks:
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+
+  - repo: https://github.com/lovesegfault/beautysh
+    rev: v6.2.1
+    hooks:
+      - id: beautysh

README.rst

@@ -1,24 +1,14 @@
 .. use the image below instead of a title
 
-.. image:: https://socialify.git.ci/sarnold/gitchangelog-action/image?language=1&owner=1&theme=Light
-    :alt: gitchangelog-action
-
-.. image:: https://github.com/sarnold/gitchangelog-action/actions/workflows/main.yml/badge.svg
-    :target: https://github.com/sarnold/gitchangelog-action/actions/workflows/main.yml
-    :alt: CI test status
-
-.. image:: https://img.shields.io/github/v/tag/sarnold/gitchangelog-action?color=green&include_prereleases&label=latest%20release
-    :target: https://github.com/sarnold/gitchangelog-action/releases
-    :alt: GitHub tag
+|splash|
 
-.. image:: https://img.shields.io/github/license/sarnold/gitchangelog-action
-    :target: https://github.com/sarnold/gitchangelog-action/blob/master/LICENSE
-    :alt: License
+|CI| |pre|
 
+|tag| |license|
 
 What is gitchangelog?
 =====================
- 
+
 gitchangelog_ creates a changelog from git log history using multiple
 template engines and a config file. Output can be either `reStructuredText`_
 or `MarkDown`_, with the latter format as default for this action (mainly
@@ -45,12 +35,12 @@ Examples
 ========
 
 The canonical dogfood_ example is the `release.yml`_ and corresponding
-`github release page`_ in the gitchangelog repo (for a non-platform wheel).
+`github release page`_ in the gitchangelog repo.
 
 
 .. _dogfood: http://catb.org/jargon/html/D/dogfood.html
 .. _release.yml: https://github.com/sarnold/gitchangelog/blob/master/.github/workflows/release.yml#L58
-.. _github release page: https://github.com/sarnold/gitchangelog/releases/tag/3.0.9
+.. _github release page: https://github.com/sarnold/gitchangelog/releases
 
 Usage
 =====
@@ -59,7 +49,7 @@ To enable the default release page changes file, create a .yml file under
 .github/workflows with the following contents.
 
 .. note:: Be sure to use the latest tag for this action if you're not
-          tracking the ``master`` branch.
+          tracking 'v1' or the ``master`` branch.
 
 Default configuration
 ---------------------
@@ -74,12 +64,12 @@ Default configuration
         name: gitchangelog-action
         runs-on: ubuntu-latest
         steps:
-          - uses: actions/checkout@v2
+          - uses: actions/checkout@v3
             with:
               fetch-depth: 0
 
           - name: gitchangelog action step
-            uses: sarnold/gitchangelog-action@master
+            uses: sarnold/gitchangelog-action@v1
             with:
               github_token: ${{ secrets.GITHUB_TOKEN}}
 
@@ -116,7 +106,7 @@ Full configuration
               echo "VERSION=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
               echo ${{ VERSION }}
 
-          - uses: actions/checkout@v2
+          - uses: actions/checkout@v3
             with:
               fetch-depth: 0
 
@@ -195,3 +185,22 @@ machine as needed.
 
 .. _Ubuntu: https://ubuntu.com/
 
+
+.. |splash| image:: https://socialify.git.ci/sarnold/gitchangelog-action/image?language=1&owner=1&theme=Light
+    :alt: gitchangelog-action
+
+.. |CI| image:: https://github.com/sarnold/gitchangelog-action/actions/workflows/main.yml/badge.svg
+    :target: https://github.com/sarnold/gitchangelog-action/actions/workflows/main.yml
+    :alt: CI test status
+
+.. |pre| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
+   :target: https://github.com/pre-commit/pre-commit
+   :alt: pre-commit
+
+.. |tag| image:: https://img.shields.io/github/v/tag/sarnold/gitchangelog-action?color=green&include_prereleases&label=latest%20release
+    :target: https://github.com/sarnold/gitchangelog-action/releases
+    :alt: GitHub tag
+
+.. |license| image:: https://img.shields.io/github/license/sarnold/gitchangelog-action
+    :target: https://github.com/sarnold/gitchangelog-action/blob/master/LICENSE
+    :alt: License

requirements.txt

@@ -1 +1 @@
-https://github.com/sarnold/gitchangelog/releases/download/3.1.1/gitchangelog-3.1.1-py3-none-any.whl
+https://github.com/sarnold/gitchangelog/releases/download/3.1.2/gitchangelog-3.1.2-py3-none-any.whl