datalad / datalad-extension-template

Minimal implementation of a DataLad extension module
http://datalad.org
Other
2 stars 17 forks source link

Incorporate CHANGELOG.md/.rst lifecycle in the template? #75

Open yarikoptic opened 1 year ago

yarikoptic commented 1 year ago

ATM there is no CHANGELOG.md here at all and thus no docs/source/changelog.rst .

many extensions seems to have it

❯ ls -ld data*/docs/source/changelog.rst
-rw------- 1 yoh yoh    184 Feb 28  2023 datalad-catalog/docs/source/changelog.rst
-rw------- 1 yoh yoh 344515 Aug 10 15:44 datalad-clone/docs/source/changelog.rst
-rw------- 1 yoh yoh   6977 Feb  1  2021 datalad-container/docs/source/changelog.rst
-rw------- 1 yoh yoh   5131 Mar 28 12:58 datalad-crawler/docs/source/changelog.rst
-rw------- 1 yoh yoh   1675 Apr 14  2020 datalad-hirni/docs/source/changelog.rst
-rw------- 1 yoh yoh   4571 Nov  3  2022 datalad-neuroimaging/docs/source/changelog.rst
-rw------- 1 yoh yoh 342267 Jul  5 09:36 datalad/docs/source/changelog.rst

but only datalad "core" has anything in its workflow to actually update it from CHANGELOG.md:

❯ grep changelog.rst */.github/workflows/release.yml
datalad/.github/workflows/release.yml:            git add docs/source/changelog.rst
datalad/.github/workflows/release.yml:            git commit -m '[skip ci] Update docs/source/changelog.rst'

as a result -- we have outdated changelogs such as https://docs.datalad.org/projects/container/en/latest/changelog.html .

The question is -- should we fix in individual extensions or do it "globally" for all extensions by making their release action do the same

FTR here is the diff from core to extension template release action

❯ diff -Naur  datalad-maint/.github/workflows/release.yml datalad-extension-template/.github/workflows/release.yml
--- datalad-maint/.github/workflows/release.yml 2023-08-16 09:29:56.896141244 -0400
+++ datalad-extension-template/.github/workflows/release.yml    2023-03-22 08:31:41.647068093 -0400
@@ -6,7 +6,7 @@
   pull_request_target:
     branches:
       # Create a release whenever a PR is merged into one of these branches:
-      - maint
+      - main
     types:
       - closed

@@ -19,20 +19,12 @@
       - name: Checkout source
         uses: actions/checkout@v3
         with:
-          token: ${{ secrets.GITMATE_GITHUB_TOKEN }}
           # Check out all history so that the previous release tag can be
           # found:
           fetch-depth: 0

-      - name: Install pandoc
-        run: sudo apt-get update && sudo apt-get install -y pandoc
-
       - name: Prepare release
         uses: datalad/release-action/release@v1
         with:
-          token: ${{ secrets.GITMATE_GITHUB_TOKEN }}
-          pypi-token: ${{ secrets.PYPI_TOKEN }}
-          pre-tag: |
-            make update-changelog
-            git add docs/source/changelog.rst
-            git commit -m '[skip ci] Update docs/source/changelog.rst'
+          token: ${{ secrets.GITHUB_TOKEN }}
+          #pypi-token: ${{ secrets.PYPI_TOKEN }}