Merge branch 'master' into feature/drop-python-2

Author: moomoohk

.github/workflows/deploy.yml

@@ -2,10 +2,10 @@ name: Deploy and Release
 
 # Controls when the workflow will run
 on:
-  # Triggers the workflow on tag push
+  # Triggers the workflow on version change
   push:
-    tags:
-      - "v*"
+    paths:
+      - "dpath/version.py"
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
@@ -19,6 +19,32 @@ jobs:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v2
 
+      - name: Get Version
+        id: get-version
+        run: |
+          python -c "from dpath.version import VERSION; print(f'::set-output name=version::v{VERSION}');"
+
+      - name: Check Tag
+        uses: mukunku/tag-exists-action@v1.0.0
+        id: check-tag
+        with:
+          tag: ${{ steps.get-version.outputs.version }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create Tag
+        if: ${{ steps.check-tag.outputs.exists }} == "false"
+        uses: negz/create-tag@v1
+        with:
+          version: ${{ steps.get-version.outputs.version }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Generate Changelog
+        id: generate-changelog
+        uses: loopwerk/tag-changelog@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
       - name: PyPI Deployment
         uses: casperdcl/deploy-pypi@v2
         with:
@@ -30,8 +56,10 @@ jobs:
           build: clean sdist -d dist/
           # `pip` command to run ("true" is a shortcut for "wheel -w <dist_dir> --no-deps .")
           pip: true
-          
+
       - name: Github Release
         uses: softprops/action-gh-release@v1
         with:
+          tag_name: ${{ steps.get-version.outputs.version }}
+          body: ${{ steps.generate-changelog.outputs.changes }}
           files: dist/*

MAINTAINERS.md

@@ -87,7 +87,9 @@ We name bugfixes as "bugfix/ISSUENUMBER_shortname"; features are named "feature/
 Cutting a New Release
 =====================
 
-Releases for dpath occur automatically from travis-ci based on tags on the master branch, or on the version/[0-9].x branches for major version LTS.
+Releases for dpath occur automatically from Github Actions based on version changes on the master branch.
+
+Due to legacy reasons older tag names do not follow a uniform format:
 
     akesterson@akesterson:~/dpath-python$ git tag
     1.0-0
@@ -108,18 +110,33 @@ Releases for dpath occur automatically from travis-ci based on tags on the maste
     build,1.5,0
     build,2.0,0
 
-Once upon a time, the version string was automatially computed based on the content of these tags. Now, however, the version string is stored statically in dpath/version.py
+Moving forward version numbers and tag names will be identical and follow the standard semver format.
+
+The version string is stored in `dpath/version.py` and tag names/release versions are generated using this string.
 
     akesterson@akesterson:~/dpath-python$ cat dpath/version.py
     VERSION = "2.0.0"
 
 To cut a new release, follow this procedure:
 
-1. Commit a new dpath/version.py on the appropriate branch with the format "MAJOR.MINOR.RELEASE"
-2. Add a new tag of the form "build,MAJOR.MINOR,RELEASE" to the appropriate branch. This tag must have the same version number as the one commmited in dpath/version.py or we will fill your desk drawers with cockroaches.
-3. Push the new branch version and the associated tag to github.
-4. travis-ci SHOULD push the new release to pypi.
+1. Commit a new `dpath/version.py` on the appropriate branch with the format "MAJOR.MINOR.RELEASE".
+2. Github Actions SHOULD push the new release to PyPI on merge to `master`.
+
+See `.github/workflows/deploy.yml` for more information.
 
-If travis-ci fails to update pypi, follow the instructions on manually creating a release, here:
+If the Github workflow fails to update pypi, follow the instructions on manually creating a release, here:
 
 https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives
+
+Deployment CI was previously implemented using [Travis CI](https://travis-ci.org/github/akesterson/dpath-python).
+
+Running Tests
+=============
+
+Tests are managed using [tox](https://tox.readthedocs.io/en/latest/).
+
+Environment creation and dependency installation is managed by this tool, all one has to do is install it with `pip` and run `tox` in this repo's root directory.
+
+Tests can also be run with Github Actions via the [tests.yml](https://github.com/dpath-maintainers/dpath-python/actions/workflows/tests.yml) workflow.
+
+This workflow will run automatically on pretty much any commit to any branch of this repo but manual runs are also available.