Fix workflow

### Fixed

- Fixed package missing the cli module in some circumstances

### Changed

- Added the `body-file` output to the github action. `body_file` still exists but is aliased to `body-file`

.github/workflows/build.yml

@@ -40,13 +40,43 @@ jobs:
       - name: Run Unit Tests
         run: python -m unittest -v
 
+  test-action:
+    name: Test Github Action
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Get Changelog Information
+        uses: ./
+        id: yaclog-show
+        with:
+          changelog-path: 'tests/Test-Changelog.md'
+
+      - name: Copy Body File
+        run:
+          cp ${{ steps.yaclog-show.outputs.body-file }} body.md
+
+      - name: Fail
+        if: >
+          !(
+          steps.yaclog-show.outputs.name == '0.13.0 "Aquarius"' &&
+          steps.yaclog-show.outputs.header == '## 0.13.0 "Aquarius" - 1970-04-11 [YANKED]' &&
+          steps.yaclog-show.outputs.version == '0.13.0' &&
+          endsWith(steps.yaclog-show.outputs.changelog, 'tests/Test-Changelog.md') &&
+          hashFiles('body.md') == 'ad49b5c946b7d361db1c3dacc73de4f6222cca6272aab426786de168eede702b'
+          )
+        run: |
+          echo "Action self-test failed!"
+          echo "${{ toJSON(steps.yaclog-show.outputs) }}"
+          echo "${{ hashFiles('body.md') }}"
+          false
+
   build:
     name: Build Distribution
-    needs: test
+    needs:
+      - test
+      - test-action
     runs-on: ubuntu-22.04
-    outputs:
-      body_file: ${{ steps.yaclog-show.outputs.body_file }}
-      version_name: ${{ steps.yaclog-show.outputs.name }}
     steps:
       - uses: actions/checkout@v4
 
@@ -55,10 +85,6 @@ jobs:
         with:
           python-version: '3.12'
 
-      - name: Get Changelog Information
-        id: yaclog-show
-        uses: ./ # self-hosting!
-
       - name: Install pypa/build
         run: python -m pip install build --user
 
@@ -101,16 +127,22 @@ jobs:
     permissions:
       contents: write
     steps:
+      - uses: actions/checkout@v4
+
       - uses: actions/download-artifact@v4
         with:
           name: python-distribution
           path: dist/
 
+      - name: Get Changelog Information
+        id: yaclog-show
+        uses: ./ # self-hosting!
+
       - name: Publish to Github
         run: >
           gh release create ${{ github.ref_name }}
-          --notes-file "${{ needs.build.outputs.body_file }}"
+          --notes-file "${{ steps.yaclog-show.outputs.body-file }}"
-          --title "${{ needs.build.outputs.version_name }}"
+          --title "${{ steps.yaclog-show.outputs.name }}"
           dist/*
         env:
           GH_TOKEN: ${{ github.token }}

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file
 
+## Version 1.4.3 - 2024-08-28
+
+### Fixed
+
+- Fixed package missing the cli module in some circumstances
+
+### Changed
+
+- Added the `body-file` output to the github action. `body_file` still exists but is aliased to `body-file`
+
+
 ## Version 1.4.2 - 2024-08-27
 
 ### Fixed

action.yaml

@@ -28,9 +28,12 @@ outputs:
   version:
     description: "The current version number. For example, `1.3.0`"
     value: ${{ steps.yaclog-show.outputs.version }}
-  body_file:
+  body-file:
     description: "Path to a temporary file containing the version body"
-    value: ${{ steps.yaclog-show.outputs.body_file }}
+    value: ${{ steps.yaclog-show.outputs.body-file }}
+  body_file:
+    description: "Alias for body-file"
+    value: ${{ steps.yaclog-show.outputs.body-file }}
   changelog:
     description: "Path to the entire changelog file."
     value: ${{ steps.yaclog-show.outputs.changelog }}

docs/handbook/changelog_files.md

@@ -34,45 +34,6 @@ Tags are additional metadata added to a version header, denoted by all-caps text
 
 ## Example
 
-```markdown
+```{literalinclude} ../../tests/Test-Changelog.md
-# Changelog
+  :language: markdown
-
-All notable changes to this project will be documented in this file.
-
-## 0.13.0 "Aquarius" - 1970-04-11 [YANKED]
-
-Yanked due to issues with oxygen tanks, currently investigating
-
-### Added
-
-- Extra propellant in preparation for future versions
-
-### Changed
-
-- Replaced Ken Mattingly
-- Stirred oxygen tanks
-
-## 0.12.0 "Intrepid" - 1969-11-14
-
-### Added
-
-- New ALSEP package for surface science
-- Color cameras
-- Surface rendezvous with Surveyor 3
-
-### Fixed
-
-- 1201/1202 alarm distracting crew during landing
-
-### Known Issues
-
-- Lightning strike during launch: No effect on performance
-
-## 0.11.0 "Eagle" - 1969-07-20
-
-Initial stable release
-
-### Changed
-
-- Fully fueled lander to allow landing on the lunar surface
 ```

docs/handbook/github_actions.md

@@ -46,7 +46,7 @@ The most recent version name, equivalent to the output of `yaclog show --name`.
 The entire header for the most recent version, equivalent to the output of `yaclog show --header`. For example, `Version 1.3.0 - 2024-08-08`
 ```
 
-```{confval} body_file
+```{confval} body-file
 The path to a temporary file containing the body of the most recent version. Contents equivalent to `yaclog show --body`
 ```
 
@@ -82,7 +82,7 @@ jobs:
         if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
         run: |
           gh release create {{ '${{ github.ref_name }}' }} \
-            --notes-file "{{ '${{ steps.yaclog.outputs.body_file }}' }}" \
+            --notes-file "{{ '${{ steps.yaclog.outputs.body-file }}' }}" \
             --title "{{ '${{ steps.yaclog.outputs.name }}' }}" 
         env:
           GH_TOKEN: {{ '${{ github.token }}' }}

tests/Test-Changelog.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 0.13.0 "Aquarius" - 1970-04-11 [YANKED]
+
+Yanked due to issues with oxygen tanks, currently investigating
+
+### Added
+
+- Extra propellant in preparation for future versions
+
+### Changed
+
+- Replaced Ken Mattingly
+- Stirred oxygen tanks
+
+## 0.12.0 "Intrepid" - 1969-11-14
+
+### Added
+
+- New ALSEP package for surface science
+- Color cameras
+- Surface rendezvous with Surveyor 3
+
+### Fixed
+
+- 1201/1202 alarm distracting crew during landing
+
+### Known Issues
+
+- Lightning strike during launch: No effect on performance
+
+## 0.11.0 "Eagle" - 1969-07-20
+
+Initial stable release
+
+### Changed
+
+- Fully fueled lander to allow landing on the lunar surface

yaclog/cli/__main__.py

@@ -123,7 +123,7 @@ def show(obj: Changelog, all_versions, markdown, mode, version_names, gh_actions
         body_fd, body_file = tempfile.mkstemp(text=True)
         with os.fdopen(body_fd, 'w') as f:
             f.write(sep.join([functions['body'](v, kwargs) for v in versions]))
-        click.echo(f'body_file={body_file}')
+        click.echo(f'body-file={body_file}')
         click.echo(f'changelog={obj.path}')
         return