From b55c5f1461e9777dc90f93cd80169bca6bf1538e Mon Sep 17 00:00:00 2001
From: Austin Macdonald <austin@dartmouth.edu>
Date: Tue, 7 May 2024 11:54:26 -0500
Subject: [PATCH] Auto releases with `auto`

Fixes: https://github.com/con/duct/issues/7
---
 .github/workflows/release.yml | 45 +++++++++++++++++++++++++++++++++++
 CONTRIBUTING.rst              | 21 ++++++++++++++++
 2 files changed, 66 insertions(+)
 create mode 100644 .github/workflows/release.yml
 create mode 100644 CONTRIBUTING.rst

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
new file mode 100644
index 00000000..b795b4bb
--- /dev/null
+++ b/.github/workflows/release.yml
@@ -0,0 +1,45 @@
+name: Auto-release on PR merge
+
+on:
+  # ATM, this is the closest trigger to a PR merging
+  push:
+    branches:
+      - master
+
+jobs:
+  auto-release:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')"
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Download auto
+        run: |
+          #curl -vL -o - "$(curl -fsSL https://api.github.com/repos/intuit/auto/releases/latest | jq -r '.assets[] | select(.name == "auto-linux.gz") | .browser_download_url')" | gunzip > ~/auto
+          # Initially pin to 10.16.1 so we don't break if & when
+          # <https://github.com/intuit/auto/issues/1778> is fixed.
+          # Needed to progress to 11.1.6 (current release) to have
+          # a fix for https://github.com/intuit/auto/issues/2432,
+          # while 1778 was still open/left without comment.
+          wget -O- https://github.com/intuit/auto/releases/download/v11.1.6/auto-linux.gz | gunzip > ~/auto
+          chmod a+x ~/auto
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '^3.8'
+
+      # - name: Install Python dependencies
+      #   run: python -m pip install build bump2version twine
+
+      - name: Create release
+        run: ~/auto shipit
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+
+# vim:set sts=2:
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 00000000..c87e4909
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,21 @@
+Releases and Changelog
+----------------------
+
+We use the `auto <https://intuit.github.io/auto/>`_ tool to generate the changelog and automatically release the project.
+
+`auto` is used in by GitHub actions, which monitors the labels on the pull request.
+This automation can add entries to the changelog, cut releases, and
+push new images to `dockerhub <https://hub.docker.com/r/centerforopenneuroscience/duct>`_.
+
+The following pull request labels are respected:
+
+    * major: Increment the major version when merged
+    * minot: Increment the minot version when merged
+    * patch: Increment the patch version when merged
+    * skip-release: Preserve the current version when merged
+    * release: Create a release when this pr is merged
+    * internal: Changes only affect the internal API
+    * documentation: Changes only affect the documentation
+    * tests: Add or improve existing tests
+    * dependencies: Update one or more dependencies version
+    * performance: Improve performance of an existing feature