Release version 1.0

.github/workflows/dotnet.yaml

@@ -138,37 +138,37 @@ jobs:
  # - uses: actions/checkout@v4
  # - uses: gaurav-nelson/github-action-markdown-link-check@v1
 
-  # nuget-publish:
- # runs-on: ubuntu-latest
- # if: ${{ !github.event.repository.fork && github.ref == 'refs/heads/main' }}
- # needs: [all-required-checks-complete]
- # environment: release
- # steps:
- #  - name: Download NuGet artifact
- #  uses: actions/download-artifact@v4
- #  with:
- #  name: nuget-package
- #  - name: Publish to NuGet
- #  run: dotnet nuget push "ShapeSifter.*.nupkg" --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json
+ nuget-publish:
+ runs-on: ubuntu-latest
+ if: ${{ !github.event.repository.fork && github.ref == 'refs/heads/main' }}
+ needs: [all-required-checks-complete]
+ environment: release
+ steps:
+ - name: Download NuGet artifact
+ uses: actions/download-artifact@v4
+ with:
+ name: nuget-package
+ - name: Publish to NuGet
+ run: dotnet nuget push "ShapeSifter.*.nupkg" --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicates
 
-  # github-tag-and-release:
- # runs-on: ubuntu-latest
- # if: ${{ !github.event.repository.fork && github.ref == 'refs/heads/main' }}
- # needs: [all-required-checks-complete]
- # environment: release
- # steps:
- #  - name: Generate app token
- #  id: app-token
- #  uses: actions/create-github-app-token@v1
- #  with:
- #  app-id: ${{ secrets.APP_ID }}
- #  private-key: ${{ secrets.APP_PRIVATE_KEY }}
- #  - uses: actions/checkout@v4
- #  with:
- #  token: ${{ steps.app-token.outputs.token }}
- #  - name: Download NuGet artifact
- #  uses: actions/download-artifact@v4
- #  - name: Tag and release packages
- #  env:
- #  GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
- #  run: bash .github/workflows/tag.sh
+ github-tag-and-release:
+ runs-on: ubuntu-latest
+ if: ${{ !github.event.repository.fork && github.ref == 'refs/heads/main' }}
+ needs: [all-required-checks-complete]
+ environment: release
+ steps:
+ - name: Generate app token
+ id: app-token
+ uses: actions/create-github-app-token@v1
+ with:
+ app-id: ${{ secrets.APP_ID }}
+ private-key: ${{ secrets.APP_PRIVATE_KEY }}
+ - uses: actions/checkout@v4
+ with:
+ token: ${{ steps.app-token.outputs.token }}
+ - name: Download NuGet artifact
+ uses: actions/download-artifact@v4
+ - name: Tag and release packages
+ env:
+ GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
+ run: bash .github/workflows/tag.sh

.github/workflows/tag.sh

@@ -28,4 +28,65 @@ case "$TAG" in
 esac
 
 # the empty target_commitish indicates the repo default branch
-run_or_echo curl -L -X POST -H "Accept: application/vnd.github+json" -H "Authorization: Bearer $GITHUB_TOKEN" -H "X-GitHub-Api-Version: 2022-11-28" https://github.com/repos/G-Research/ShapeSifter/releases -d '{"tag_name":"'"$TAG"'","target_commitish":"","name":"'"$TAG"'","draft":false,"prerelease":false,"generate_release_notes":false}'
+curl_body='{"tag_name":"'"$TAG"'","target_commitish":"","name":"'"$TAG"'","draft":false,"prerelease":false,"generate_release_notes":false}'
+
+# process_curl_error expects no arguments, but reads the output of `curl` from the file `curl_output.json`.
+script_exit_code=-1
+process_curl_error() {
+ jq_query='if .errors | length == 1 then .errors[0].code else null end'
+ if ! jq -r --exit-status "$jq_query" curl_output.json; then
+ echo "Unexpectedly got number of errors not equal to 1"
+ cat curl_output.json
+ script_exit_code=3
+ else
+ github_error="$(jq -r "$jq_query" curl_output.json)"
+ echo "Error reported by GitHub: $github_error"
+
+ if [ "$github_error" != "already_exists" ]; then
+ echo "Unrecognised error message"
+ script_exit_code=4
+ else
+ # Expected: we tried to make a release that already exists, which can happen when path filters prevent a new tag
+ script_exit_code=0
+ fi
+ fi
+}
+
+test_process_curl_error() {
+ echo "Running tests."
+
+ failed_output=$(cat <<'EOF'
+{
+ "message": "Validation Failed",
+ "errors": [
+ {
+ "resource": "Release",
+ "code": "already_exists",
+ "field": "tag_name"
+ }
+ ],
+ "documentation_url": "https://docs.github.com/rest/releases/releases#create-a-release"
+}
+EOF
+)
+ echo "$failed_output" > curl_output.json
+ process_curl_error
+ if [ $script_exit_code != 0 ] ; then
+ echo "Test failure: got exit code $script_exit_code when we expected 0"
+ exit $script_exit_code
+ fi
+
+ echo "Tests completed."
+}
+
+if [[ "$DRY_RUN" = "1" ]]; then
+ test_process_curl_error
+else
+ if curl --fail-with-body -L -X POST -H "Accept: application/vnd.github+json" -H "Authorization: Bearer $GITHUB_TOKEN" -H "X-GitHub-Api-Version: 2022-11-28" https://github.com/repos/G-Research/ShapeSifter/releases -d "$curl_body" > curl_output.json ; then
+ cat curl_output.json
+ echo "cURL succeeded."
+ else
+ process_curl_error
+ exit $script_exit_code
+ fi
+fi

ShapeSifter/version.json

@@ -1,7 +1,16 @@
 {
- "version": "0.4",
+ "version": "1.0",
  "publicReleaseRefSpec": [
  "^refs/heads/main$"
  ],
- "pathFilters": null
-}
+ "pathFilters": [
+ ":/",
+ ":^ShapeSifter.Test/",
+ ":^/.github/",
+ ":^/.config/",
+ ":^/hooks/",
+ ":^/analyzers/",
+ ":^/.editorconfig",
+ ":^/CONTRIBUTING.md"
+ ]
+}