Add a new action-gh-release-parameters input

This is a JSON string that can contain most parameters accepted by the
`softprops/action-gh-release@v2` action.

Author: autarch

.github/workflows/test-no-changes-file.yml

@@ -30,8 +30,14 @@ jobs:
           executable-name: test-project
           target: x86_64-unknown-linux-gnu
           changes-file: ""
-          # We don't want to actually do a release when running tests.
-          release-tag-prefix: "do-not-release"
+          # We always to do a release during tests, just to make sure that the release part of the
+          # action works.
+          _force-release-for-testing: true
+          action-gh-release-parameters: |
+            {
+                "repository": "houseabsolute/actions-rust-release-testing",
+                "token": "${{ secrets.ACTIONS_RUST_RELEASE_TESTING_TOKEN }}"
+            }
       - name: Install psutils on Windows
         run: choco install --ignore-checksums psutils
         if: runner.os == 'Windows'

.github/workflows/test-working-directory.yml

@@ -50,8 +50,14 @@ jobs:
           executable-name: sub-project
           working-directory: sub-project
           target: ${{ matrix.platform.target }}
-          # We don't want to actually do a release when running tests.
-          release-tag-prefix: "do-not-release"
+          # We always to do a release during tests, just to make sure that the release part of the
+          # action works.
+          _force-release-for-testing: true
+          action-gh-release-parameters: |
+            {
+                "repository": "houseabsolute/actions-rust-release-testing",
+                "token": "${{ secrets.ACTIONS_RUST_RELEASE_TESTING_TOKEN }}"
+            }
       - name: Install psutils on Windows
         run: choco install --ignore-checksums psutils
         if: runner.os == 'Windows'

.github/workflows/test.yml

@@ -48,8 +48,14 @@ jobs:
         with:
           executable-name: test-project
           target: ${{ matrix.platform.target }}
-          # We don't want to actually do a release when running tests.
-          release-tag-prefix: "do-not-release"
+          # We always to do a release during tests, just to make sure that the release part of the
+          # action works.
+          _force-release-for-testing: true
+          action-gh-release-parameters: |
+            {
+                "repository": "houseabsolute/actions-rust-release-testing",
+                "token": "${{ secrets.ACTIONS_RUST_RELEASE_TESTING_TOKEN }}"
+            }
       - name: Install psutils on Windows
         run: choco install --ignore-checksums psutils
         if: runner.os == 'Windows'

Changes.md

@@ -2,6 +2,10 @@
 
 - Added validation for all input parameters. This should provide better errors when a required
   parameter is missing or a parameter is invalid (like referring to a path which does not exist).
+- Added a new `action-gh-release-parameters` input parameter. This takes a JSON string which can
+  contain most parameters accepted by the
+  [the `softprops/action-gh-release@v2` action](https://github.com/softprops/action-gh-release)
+  action.
 
 ## 0.0.5 - 2025-02-09
 

README.md

@@ -128,6 +128,17 @@ If you set this to an empty string, then no changelog file will be included.
 The current working directory in which all actions are performed. This defaults to the checked out
 repo's root. You use relative paths to set this to a subdirectory in the repo.
 
+### `action-gh-release-parameters`
+
+- **Required**: no
+
+This must be a string containing valid JSON. The JSON should be an object where the keys are the
+parameters for
+[the `softprops/action-gh-release@v2` action](https://github.com/softprops/action-gh-release).
+
+Note that the `actions-rust-release` action will always set the `draft` and `files` parameters, so
+any values you set for these parameter will be in the JSON string will be ignored.
+
 ## Outputs
 
 This action provides two outputs.

action.yml

@@ -58,6 +58,16 @@ inputs:
       current working directory.
     default: "."
 
+  action-gh-release-parameters:
+    description: |
+      A JSON string containing parameters to pass to `softprops/action-gh-release@v2`. You can use
+      the `toJSON()` function in your action to make passing this easier.
+    default: "{}"
+
+  _force-release-for-testing:
+    description: |
+      This exists to let me test the release parts of this action.
+
 outputs:
   artifact-id:
     description: |
@@ -93,6 +103,7 @@ runs:
         INPUTS_extra-files: ${{ inputs.extra-files }}
         INPUTS_changes_file: ${{ inputs.changes-file }}
         INPUTS_working_directory: ${{ inputs.working-directory }}
+        INPUTS_action_gh_release_parameters: ${{ inputs.action-gh-release-parameters }}
 
     - name: Package as archive
       id: package-archive
@@ -114,8 +125,8 @@ runs:
 
         cd ${{ inputs.working-directory }}
         shasum --algorithm 256 \
-            "${{ steps.package-archive.outputs.archive-basename }}" \
-            > "${{ steps.package-archive.outputs.archive-basename }}.sha256"
+            "${{ steps.package-archive.outputs.archive-file }}" \
+            > "${{ steps.package-archive.outputs.archive-file }}.sha256"
       if: runner.os != 'Windows'
 
     - name: Install dos2unix and psutils on Windows
@@ -129,23 +140,44 @@ runs:
       run: |
         cd ${{ inputs.working-directory }}
         shasum --algorithm 256 `
-            "${{ steps.package-archive.outputs.archive-basename }}" `
-            > "${{ steps.package-archive.outputs.archive-basename }}.sha256"
-        dos2unix "${{ steps.package-archive.outputs.archive-basename }}.sha256"
+            "${{ steps.package-archive.outputs.archive-file }}" `
+            > "${{ steps.package-archive.outputs.archive-file }}.sha256"
+        dos2unix "${{ steps.package-archive.outputs.archive-file }}.sha256"
       if: runner.os == 'Windows'
 
     - name: Publish release artifact for run
       id: publish-release-artifact
       uses: actions/upload-artifact@v4
       with:
-        name: ${{ steps.package-archive.outputs.archive-basename }}
-        path: ${{ inputs.working-directory }}/${{ steps.package-archive.outputs.archive-basename }}*
+        name: ${{ steps.package-archive.outputs.archive-file }}
+        path: ${{ inputs.working-directory }}/${{ steps.package-archive.outputs.archive-file }}*
+
+    - name: Parse `action-gh-release-parameters` and set inputs for `softprops/action-gh-release`
+      id: action-gh-release-parameters
+      shell: bash
+      run: |
+        set -e
+        set -x
+        set -o pipefail
+
+        FAKE_TAG=""
+        if [ -n "${{ inputs._force-release-for-testing }}" ]; then
+            workflow_path=${${{ github.workflow_ref }}%%@*}
+            workflow_file=basename "$workflow_path"
+            FAKE_TAG="v-${{ github.ref_name }}-${{ github.sha }}-${{ github.run_number }}-$workflow_file"
+        fi
+        # This will get the inputs JSON from the `ACTION_GH_RELEASE_PARAMETERS` env var. This avoids
+        # any string interpolation issues, since the inputs will contain quotes.
+        parse-and-set-action-gh-release-parameters.py \
+            --working-directory "${{ inputs.working-directory }}" \
+            --archive-file "${{ steps.package-archive.outputs.archive-file }}" \
+            --changes-file "${{ inputs.changes-file }}" \
+            --fake-tag "$FAKE_TAG"
+      env:
+        ACTION_GH_RELEASE_PARAMETERS: ${{ inputs.action-gh-release-parameters }}
+      if: ( github.ref_type == 'tag' && startsWith( github.ref_name, inputs.release-tag-prefix ) ) || inputs._force-release-for-testing
 
     - name: Publish GitHub release
       uses: softprops/action-gh-release@v2
-      with:
-        draft: true
-        # The trailing "*" should pick up the checksum file.
-        files: ${{ inputs.working-directory }}/${{ steps.package-archive.outputs.archive-basename }}*
-        body_path: ${{ ( inputs.changes-file && format( '{0}/{1}', inputs.working-directory, inputs.changes-file ) ) || '' }}
-      if: github.ref_type == 'tag' && startsWith( github.ref_name, inputs.release-tag-prefix )
+      with: ${{ steps.action-gh-release-parameters.outputs }}
+      if: ( github.ref_type == 'tag' && startsWith( github.ref_name, inputs.release-tag-prefix ) ) || inputs._force-release-for-testing

make-archive.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 
+# Mostly written by Claude.ai.
+
 import os
 import sys
 import glob
@@ -110,7 +112,7 @@ def gather_additional_files(
 ) -> List[str]:
     """Gather additional files to include in the archive."""
     if extra_files:
-        return extra_files.strip().split("\n")
+        return list(filter(None, map(str.strip, extra_files.splitlines())))
 
     files = []
     if changes_file:
@@ -126,8 +128,8 @@ def create_archive(
     td = None
     try:
         td = tempfile.mkdtemp()
-        # Copy files to temporary directory
-        for file in [f for f in found_files if f]:
+
+        for file in found_files:
             shutil.copy2(file, td)
 
         # Set executable permissions
@@ -172,7 +174,7 @@ def write_github_output(archive_file: str) -> None:
         sys.exit("GITHUB_OUTPUT environment variable not set.")
 
     with open(output_file, "a") as f:
-        print(f"archive-basename={Path(archive_file).name}", file=f)
+        print(f"archive-file={Path(archive_file).name}", file=f)
 
 
 def target_to_archive_name(target: str) -> str:

parse-and-set-action-gh-release-parameters.py

@@ -0,0 +1,66 @@
+#!/usr/bin/env python3
+
+import argparse
+import json
+import os
+import sys
+from typing import Any, Dict
+
+
+def main():
+    args = parse_arguments()
+    validate_arguments(args)
+
+    archive_path = os.path.join(args.working_directory, args.archive_file)
+    if not os.path.isfile(archive_path):
+        sys.exit(f"Archive file '{archive_path}' does not exist.")
+
+    vars = json.loads(os.environ["ACTION_GH_RELEASE_PARAMETERS"])
+    vars["draft"] = True
+    # Appending a glob ensures we pick up the checksum file as well.
+    vars["files"] = f"{archive_path}*"
+
+    if args.changes_file:
+        vars["body_path"] = args.changes_file
+
+    if args.fake_tag:
+        vars["tag_name"] = args.fake_tag
+
+    write_github_output(args.archive_file, vars)
+
+
+def parse_arguments() -> argparse.Namespace:
+    """Parse and return command line arguments."""
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--working-directory", required=True)
+    parser.add_argument("--archive-file", required=True)
+    parser.add_argument("--changes-file", required=True)
+    parser.add_argument("--fake-tag")
+    return parser.parse_args()
+
+
+def validate_arguments(args: argparse.Namespace) -> None:
+    """Validate command line arguments."""
+    if not args.working_directory or not os.path.isdir(args.working_directory):
+        sys.exit("You must provide directory for the --working-directory option.")
+
+    if not args.archive_file:
+        sys.exit("You must provide a file file for the --archive-file option.")
+
+    if args.changes_file and not os.path.isfile(args.changes_file):
+        sys.exit(f"Changes file '{args.changes_file}' does not exist.")
+
+
+def write_github_output(archive_file: str, vars: Dict[str, Any]) -> None:
+    """Write the archive information to GitHub Actions output."""
+    output_file = os.environ.get("GITHUB_OUTPUT", os.devnull)
+    if not output_file:
+        sys.exit("GITHUB_OUTPUT environment variable not set.")
+
+    with open(output_file, "a") as f:
+        # for each key in sorted order from vars, print it to the output file
+        for key in sorted(vars.keys()):
+            print(f"{key}={vars[key]}", file=f)
+
+
+main()

validate-inputs.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 
 import os
+import json
 from pathlib import Path
 from typing import Dict, List, Union
 import tempfile
@@ -98,6 +99,15 @@ def validate(self) -> List[str]:
         if "extra_files" in self.inputs:
             validation_errors.extend(self.validate_extra_files())
 
+        # Validate action-gh-release-parameters JSON if present
+        if "action_gh_release_parameters" in self.inputs:
+            try:
+                json.loads(self.inputs["action_gh_release_parameters"])
+            except json.JSONDecodeError:
+                validation_errors.append(
+                    "'action-gh-release-parameters' must be valid JSON"
+                )
+
         return validation_errors
 
     def validate_extra_files(self) -> List[str]: