From d0dd06cf3cd7eb898aa50caaec79a5d234555c88 Mon Sep 17 00:00:00 2001 From: Kent Pitman Date: Fri, 11 Aug 2023 13:35:25 -0400 Subject: [PATCH 1/2] Autodoc on non-beta tagging. Remove some empty module doc. This repo doesn't put code in __init__.py --- .github/workflows/main-deploy-docs.yml | 11 +++++++++-- CHANGELOG.rst | 6 ++++++ docs/source/submitr.rst | 8 -------- docs/source/submitr.scripts.rst | 8 -------- docs/source/submitr.tests.rst | 8 -------- 5 files changed, 15 insertions(+), 26 deletions(-) diff --git a/.github/workflows/main-deploy-docs.yml b/.github/workflows/main-deploy-docs.yml index 2abb5ca..c422efd 100644 --- a/.github/workflows/main-deploy-docs.yml +++ b/.github/workflows/main-deploy-docs.yml @@ -3,8 +3,15 @@ name: deploy-docs -# Controls when the action will run. +# Controls when the action will run. on: + # All non-beta tag pushes. + push: + tags: + - 'v*' + except: + - 'v*b*' + # Allows you to run this workflow manually from the Actions tab workflow_dispatch: @@ -22,4 +29,4 @@ jobs: - name: Docs env: DOCS_TOKEN: ${{ secrets.DOCS_TOKEN }} - run: curl -X POST -d "branches=master" -d "token=$DOCS_TOKEN" https://readthedocs.org/api/v2/webhook/submitr/246175/ + run: curl -X POST -d "ref=master" -d "token=$DOCS_TOKEN" https://readthedocs.org/api/v2/webhook/submitr/246175/ diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a0a45db..a2e8b5b 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -6,6 +6,12 @@ submitr Change Log ---------- +0.4.0 +===== + +* Auto-submit to readthedocs on any non-beta version tag push (v* except v*b*). + + 0.3.0 ===== diff --git a/docs/source/submitr.rst b/docs/source/submitr.rst index 854ef11..4e02965 100644 --- a/docs/source/submitr.rst +++ b/docs/source/submitr.rst @@ -44,11 +44,3 @@ submitr.utils module :members: :undoc-members: :show-inheritance: - -Module contents ---------------- - -.. automodule:: submitr - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/submitr.scripts.rst b/docs/source/submitr.scripts.rst index fc6055e..53dd56a 100644 --- a/docs/source/submitr.scripts.rst +++ b/docs/source/submitr.scripts.rst @@ -35,11 +35,3 @@ submitr.scripts.upload\_item\_data module :members: :undoc-members: :show-inheritance: - -Module contents ---------------- - -.. automodule:: submitr.scripts - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/submitr.tests.rst b/docs/source/submitr.tests.rst index 9b362a3..113eb47 100644 --- a/docs/source/submitr.tests.rst +++ b/docs/source/submitr.tests.rst @@ -67,11 +67,3 @@ submitr.tests.test\_utils module :members: :undoc-members: :show-inheritance: - -Module contents ---------------- - -.. automodule:: submitr.tests - :members: - :undoc-members: - :show-inheritance: From 218aaec36e2d2bfc4bf5962cf6d1beb5e5147892 Mon Sep 17 00:00:00 2001 From: Kent Pitman Date: Fri, 11 Aug 2023 13:50:20 -0400 Subject: [PATCH 2/2] Don't wait for manual confirmation on autodoc. Add changelog. Bump patch version. --- .github/workflows/main-deploy-docs.yml | 3 --- CHANGELOG.rst | 7 ++++++- pyproject.toml | 2 +- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/main-deploy-docs.yml b/.github/workflows/main-deploy-docs.yml index c422efd..b33e28b 100644 --- a/.github/workflows/main-deploy-docs.yml +++ b/.github/workflows/main-deploy-docs.yml @@ -12,9 +12,6 @@ on: except: - 'v*b*' - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - # A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: # This workflow contains a single job called "build" diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a2e8b5b..95769c1 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -6,10 +6,15 @@ submitr Change Log ---------- -0.4.0 +0.3.1 ===== * Auto-submit to readthedocs on any non-beta version tag push (v* except v*b*). +* Fix a bug in readthedocs submission where we were using branches=master and getting an error saying + ``{"detail":"Parameter \"ref\" is required"}``. ChatGPT thinks this is because we wanted a curl + parameter of ``-d "ref=master"`` rather than ``-d "branches=master"`` like we had. +* Remove spurious "Module Contents" headings in three places. + We do not put code in ``__init__.py`` so these sections would always be empty (and confusing). 0.3.0 diff --git a/pyproject.toml b/pyproject.toml index 8ddc2d4..e9daae9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "submitr" -version = "0.3.0" +version = "0.3.1" description = "Support for uploading file submissions to SMAHT." # TODO: Update this email address when a more specific one is available for SMaHT. authors = ["4DN-DCIC Team "]