Release 0.3.0 (#60)

* Release 0.3.0

* Add main branch guard to release workflow validate job

Agent-Logs-Url: https://github.com/directus/openapi/sessions/52d12eed-b043-4e6d-81d6-c9b2961b0f0b

Co-authored-by: licitdev <26413686+licitdev@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: licitdev <26413686+licitdev@users.noreply.github.com>

Author: licitdev

.github/workflows/release.yml

@@ -1,82 +1,66 @@
 # Based on https://github.com/directus/eslint-config/blob/main/.github/workflows/release.yml
+# Version must already be bumped in package.json via a PR before running this workflow
 
 name: Release
 
 on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: SemVer for the release, for example "1.0.0"
-        required: true
-        type: string
+  workflow_dispatch: {}
 
 jobs:
-  check-version:
-    name: Check Version
+  validate:
+    name: Validate
     runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
     outputs:
       version: ${{ steps.version.outputs.release }}
       is-prerelease: ${{ steps.version.outputs.prerelease && true || false }}
-    steps:
-      - name: Check version
-        uses: madhead/semver-utils@v4
-        id: version
-        with:
-          version: ${{ inputs.version }}
-          lenient: false
-
-  validate:
-    name: Validate
-    needs: check-version
-    runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
       - name: Setup env
         uses: ./.github/actions/setup
 
+      - name: Read version from package.json
+        id: pkg-version
+        run: echo "version=$(node -p 'require("./package.json").version')" >> "$GITHUB_OUTPUT"
+
+      - name: Check version
+        uses: madhead/semver-utils@v4
+        id: version
+        with:
+          version: ${{ steps.pkg-version.outputs.version }}
+          lenient: false
+
       - name: Build
         run: pnpm run build
 
-  create-version:
-    name: Create Version
-    needs:
-      - check-version
-      - validate
+  create-tag:
+    name: Create Tag
+    needs: validate
     runs-on: ubuntu-latest
     permissions:
       contents: write
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Setup env
-        uses: ./.github/actions/setup
-
-      - name: Bump version
-        run: pnpm version --no-git-tag-version '${{ needs.check-version.outputs.version }}'
-
-      - name: Create version commit & tag
+      - name: Create tag
         run: |
-          author='${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com>'
-          version='v${{ needs.check-version.outputs.version }}'
-          branch='${{ github.ref }}'
+          version='v${{ needs.validate.outputs.version }}'
 
           git config user.name 'github-actions[bot]'
           git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
 
-          git commit --all --author "$author" --message "$version"
-
           git tag --annotate "$version" --message "$version"
 
-          git push --atomic origin "$branch" "refs/tags/${version}"
+          git push origin "refs/tags/${version}"
 
   create-release:
     name: Create Release
     needs:
-      - check-version
-      - create-version
+      - validate
+      - create-tag
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -89,24 +73,24 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           gh release create \
-            'v${{ needs.check-version.outputs.version }}' \
+            'v${{ needs.validate.outputs.version }}' \
             --verify-tag \
             --generate-notes \
-            ${{ needs.check-version.outputs.is-prerelease == 'true' && '--prerelease' || '' }}
+            ${{ needs.validate.outputs.is-prerelease == 'true' && '--prerelease' || '' }}
 
   publish-npm:
     name: Publish to NPM
     needs:
-      - check-version
-      - create-version
+      - validate
+      - create-tag
     runs-on: ubuntu-latest
     permissions:
       id-token: write
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
-          ref: refs/tags/v${{ needs.check-version.outputs.version }}
+          ref: refs/tags/v${{ needs.validate.outputs.version }}
 
       - name: Setup env
         uses: ./.github/actions/setup
@@ -123,4 +107,4 @@ jobs:
           pnpm publish \
             --access=public \
             --no-git-checks \
-            --tag ${{ needs.check-version.outputs.is-prerelease == 'true' && 'canary'  || 'latest' }}
+            --tag ${{ needs.validate.outputs.is-prerelease == 'true' && 'canary' || 'latest' }}

README.md

@@ -28,4 +28,5 @@ Examples of how to use the equivalent of the documented REST endpoint in the JS
 
 To deploy a new release to npm:
 
-- Run the [release workflow](https://github.com/directus/openapi/actions/workflows/release.yml)
+1. Bump the version in `package.json` via a PR and merge it into `main`
+2. Run the [release workflow](https://github.com/directus/openapi/actions/workflows/release.yml)

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@directus/openapi",
 	"private": false,
-	"version": "0.2.2",
+	"version": "0.3.0",
 	"description": "OpenAPI Specification of the Directus API",
 	"homepage": "https://directus.io",
 	"repository": {