Merge pull request #54 from UoMResearchIT/release

dkfellows · web-flow · commit 7fb1e2c1d0a3 · 2025-04-29T14:51:30.000+01:00
Release v1.0
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -45,6 +45,7 @@ body:
         - "0.1"
         - "0.2"
         - "v0.3"
+        - "v1.0"
         - "other"
       default: 0
   - type: input
diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md
@@ -20,9 +20,7 @@ Release checklist:
 - [ ] Make a `release` branch
 - [ ] Make a PR for it <!-- using this template... -->
 - [ ] Update version numbers, checking `README.md`s, `action.yml`s, and `bug.yml` in the issue templates
-- [ ] Tag the release
-- [ ] Rerun known tests after pointing them at the tag
-- [ ] Fill in the release description data ("drafting" a release)
-- [ ] Double-check you've done nothing silly!
-- [ ] Make the GitHub release
+- [ ] Draft the release (filling in release description data, prepping the tag to be set on the `release` branch)
+- [ ] Rerun known tests after pointing them at the version to be tagged
+- [ ] Make the GitHub release draft into a release
 - [ ] Merge the PR and delete the branch
diff --git a/apt-get-install/README.md b/apt-get-install/README.md
@@ -5,7 +5,7 @@ Installs packages on a Debian or Ubuntu runner. Does not support any other OS, b
 Example usage:
 
 ```yml
-  - uses: UoMResearchIT/actions/apt-get-install@v0.3
+  - uses: UoMResearchIT/actions/apt-get-install@v1.0
     with:
       packages: vera++
 ```
diff --git a/check-copyrights/README.md b/check-copyrights/README.md
@@ -9,7 +9,7 @@ Note that, in general, all public files with a suitable human-readable comment f
 Example usage:
 
 ```yml
-    - uses: UoMResearchIT/actions/check-copyrights@v0.3
+    - uses: UoMResearchIT/actions/check-copyrights@v1.0
       with:
         profile: ASL
 ```
diff --git a/check-ruleset-containment/README.md b/check-ruleset-containment/README.md
@@ -5,9 +5,9 @@ from a standard model ruleset (the "expected" ruleset).
 
 Example:
 ```yml
-      - uses: UoMResearchIT/actions/get-repo-ruleset@v0.3
+      - uses: UoMResearchIT/actions/get-repo-ruleset@v1.0
         id: get-rules
-      - uses: UoMResearchIT/actions/check-ruleset-containment@v0.3
+      - uses: UoMResearchIT/actions/check-ruleset-containment@v1.0
         with:
           current: ${{ steps.get-rules.outputs.filename }}
           expected: project_setup/my_ruleset_file.json
diff --git a/commit-id/README.md b/commit-id/README.md
@@ -10,7 +10,7 @@ It's assumed that updated file will not be committed back to the repository; thi
 ### C and C++
 
 ```yml
-  - uses: UoMResearchIT/actions/commit-id@v0.3
+  - uses: UoMResearchIT/actions/commit-id@v1.0
     with:
       file: src/build_id.h
 ```
@@ -22,7 +22,7 @@ Which might be paired with a source file (in `src/build_id.h` for example) like
 ```
 ### Python
 ```yml
-  - uses: UoMResearchIT/actions/commit-id@v0.3
+  - uses: UoMResearchIT/actions/commit-id@v1.0
     with:
       file: src/version.py
 ```
diff --git a/compare-output/README.md b/compare-output/README.md
@@ -11,7 +11,7 @@ The expected and actual outputs are written to the log to aid debugging of failu
 Example usage:
 
 ```yml
-  - uses: UoMResearchIT/actions/compare-output@v0.3
+  - uses: UoMResearchIT/actions/compare-output@v1.0
     with:
       command: echo foo
       expected: foo
diff --git a/configure-nuget-for-github/README.md b/configure-nuget-for-github/README.md
@@ -4,7 +4,7 @@ This configures NuGet so that it can access the organisation namespace for packa
 
 Example:
 ```yml
-  - uses: UoMResearchIT/actions/configure-nuget-for-github@main
+  - uses: UoMResearchIT/actions/configure-nuget-for-github@v1.0
 ```
 
 # inputs
diff --git a/docker-publish-to-ghcr/README.md b/docker-publish-to-ghcr/README.md
@@ -6,7 +6,7 @@ This action does _not_ create the local image.
 Example usage:
 
 ```yml
-  - uses: UoMResearchIT/actions/docker-publish-to-ghcr@v0.3
+  - uses: UoMResearchIT/actions/docker-publish-to-ghcr@v1.0
     with:
       source-tag: testing
       version: latest
diff --git a/download/README.md b/download/README.md
@@ -4,15 +4,15 @@ Downloads a file from a URL, using a cached version if possible.
 
 Example:
 ```yml
-  - uses: UoMResearchIT/actions/download@v0.3
+  - uses: UoMResearchIT/actions/download@v1.0
     with:
       url: https://research-it.manchester.ac.uk/
       local-name: homepage.html
 ```
 
 Example of accessing a protected resource:
 ```yml
-  - uses: UoMResearchIT/actions/download@main
+  - uses: UoMResearchIT/actions/download@v1.0
     with:
       url: https://api.github.com/repo/UoMResearchIT/actions=test/contents/README.md
       local-name: read-me.md
diff --git a/doxygen-to-pages/README.md b/doxygen-to-pages/README.md
@@ -5,7 +5,7 @@ Github Pages (see [actions/deploy-pages](https://github.com/actions/deploy-pages
 
 Example:
 ```yml
-  - uses: UoMResearchIT/actions/doxygen-to-pages@v0.3
+  - uses: UoMResearchIT/actions/doxygen-to-pages@v1.0
 ```
 
 The `Doxyfile` should have these set (these are default values):
diff --git a/get-repo-ruleset/README.md b/get-repo-ruleset/README.md
@@ -4,7 +4,7 @@ Gets the ruleset applied to a particular branch of a repository.
 
 Example:
 ```yml
-      - uses: UoMResearchIT/actions/get-repo-ruleset@v0.3
+      - uses: UoMResearchIT/actions/get-repo-ruleset@v1.0
         id: rules
       - run: jq . < $THE_FILE
         env:
diff --git a/instantiate-file/README.md b/instantiate-file/README.md
@@ -5,7 +5,7 @@ This action is careful to delete the file later in the workflow (after it should
 
 Example:
 ```yml
-      - uses: UoMResearchIT/actions/instantiate-file@v0.3
+      - uses: UoMResearchIT/actions/instantiate-file@v1.0
         id: mkfile
         with:
           value: SGVsbG8sIHdvcmxkLg==
@@ -19,7 +19,7 @@ Example:
 This action is intended for use with secrets, making them available to later workflow steps that expect them
 in files:
 ```yml
-      - uses: UoMResearchIT/actions/instantiate-file@v0.3
+      - uses: UoMResearchIT/actions/instantiate-file@v1.0
         with:
           value: ${{ secrets.ENCODED_PRIVATE_KEY }}
           filename: privateKey.pem
diff --git a/python-import-all-test/README.md b/python-import-all-test/README.md
@@ -8,7 +8,7 @@ Assumes that Python has already been set up.
 
 Example usage:
 ```yml
-  - uses: UoMResearchIT/actions/python-import-all-test@v0.3
+  - uses: UoMResearchIT/actions/python-import-all-test@v1.0
     with:
       module: mymodule
 ```
diff --git a/reuse/README.md b/reuse/README.md
@@ -46,7 +46,7 @@ jobs:
       uses: actions/checkout@v4
 
     - name: REUSE Compliance Check
-      uses: UoMResearchIT/reuse@v0.3
+      uses: UoMResearchIT/reuse@v1.0
 ```
 
 If you would like to run other subcommands, you could use the following snippet which outputs a the SPDX bill of materials:
@@ -55,7 +55,7 @@ If you would like to run other subcommands, you could use the following snippet
     - name: Checkout
       uses: actions/checkout@v4
     - name: REUSE SPDX SBOM
-      uses: UoMResearchIT/reuse@v0.3
+      uses: UoMResearchIT/reuse@v1.0
       with:
         args: spdx
 ```
@@ -66,7 +66,7 @@ In the same fashion, it is possible to add optional arguments like `--include-su
     - name: Checkout
       uses: actions/checkout@v4
     - name: REUSE Compliance Check
-      uses: UoMResearchIT/reuse@v0.3
+      uses: UoMResearchIT/reuse@v1.0
       with:
         args: --include-submodules lint
 ```
diff --git a/run-c-style-check/README.md b/run-c-style-check/README.md
@@ -8,7 +8,7 @@ This runs a [simple style checker](https://github.com/verateam/vera) on a direct
 Example usage:
 
 ```yml
-  - uses: UoMResearchIT/actions/run-c-style-check@v0.3
+  - uses: UoMResearchIT/actions/run-c-style-check@v1.0
     with:
       base-dir: src
 ```
diff --git a/run-c-style-check/action.yml b/run-c-style-check/action.yml
@@ -42,7 +42,7 @@ runs:
   using: composite
   steps:
     - name: install vera
-      uses: UoMResearchIT/actions/apt-get-install@v0.3
+      uses: UoMResearchIT/actions/apt-get-install@v1.0
       with:
         packages: vera++
     - name: analyse code
diff --git a/run-clang-tidy/README.md b/run-clang-tidy/README.md
@@ -5,7 +5,7 @@ Runs [clang-tidy](https://clang.llvm.org/extra/clang-tidy/) against a C or C++ c
 Example usage:
 
 ```yml
-  - uses: UoMResearchIT/actions/run-clang-tidy@v0.3
+  - uses: UoMResearchIT/actions/run-clang-tidy@v1.0
 ```
 
 > [!IMPORTANT]
diff --git a/run-clang-tidy/action.yml b/run-clang-tidy/action.yml
@@ -46,7 +46,7 @@ runs:
   using: composite
   steps:
     - name: Install clang-tidy
-      uses: UoMResearchIT/actions/apt-get-install@v0.3
+      uses: UoMResearchIT/actions/apt-get-install@v1.0
       with:
         packages: clang-tidy
     - name: Run clang-tidy
diff --git a/run-pylint/README.md b/run-pylint/README.md
@@ -11,15 +11,15 @@ Runs pylint on a Python package.
 Example basic usage:
 
 ```yml
-  - uses: UoMResearchIT/actions/run-pylint@v0.3
+  - uses: UoMResearchIT/actions/run-pylint@v1.0
     with:
       package: mycode.pkg_name
 ```
 
 Example usage with spell checking:
 
 ```yml
-  - uses: UoMResearchIT/actions/run-pylint@v0.3
+  - uses: UoMResearchIT/actions/run-pylint@v1.0
     with:
       package: mycode.pkg_name
       language: en_GB
diff --git a/run-pylint/action.yml b/run-pylint/action.yml
@@ -104,7 +104,7 @@ runs:
         USER_LANG: ${{ inputs.language }}
     - name: Install spell checker
       if: inputs.language != ''
-      uses: UoMResearchIT/actions/apt-get-install@v0.3
+      uses: UoMResearchIT/actions/apt-get-install@v1.0
       with:
         packages: enchant-2 hunspell libhunspell-dev ${{ steps.lang.outputs.pkg }}
     - name: Build composite dictionary
diff --git a/todo/README.md b/todo/README.md
@@ -6,7 +6,7 @@ The warnings are surfaced in the summary.
 
 Usage:
 ```yml
-  - uses: UoMResearchIT/actions/todo@v0.3
+  - uses: UoMResearchIT/actions/todo@v1.0
 ```
 
 > [!NOTE]
