Merge pull request #24 from matrix-org/t3chguy-patch-1

Automate releases

.github/workflows/release.yaml

@@ -0,0 +1,57 @@
+name: Release Automation
+on:
+  workflow_dispatch:
+    inputs:
+      version-bump:
+        description: The scale of the version bump required for semver compatibility
+        required: true
+        default: patch
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+concurrency: release
+jobs:
+  release:
+    name: "Release & Publish"
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🧮 Checkout code
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.ELEMENT_BOT_TOKEN }}
+
+      - name: 🔧 Set up node environment
+        uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+
+      - name: 🛠️ Setup
+        run: yarn install --pure-lockfile
+
+      - name: 👊 Bump version
+        run: |
+          yarn version --no-git-tag-version --${{ github.event.inputs.version-bump }}
+          git config --global user.name 'ElementRobot'
+          git config --global user.email '[email protected]'
+          git commit -am "{{ github.event.inputs.version-bump }} version bump"
+          git push
+
+      - name: 🚀 Publish to npm
+        id: npm-publish
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          access: public
+
+      - name: 🧬 Create release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: v${{ steps.npm-publish.outputs.version }}
+          release_name: Release ${{ steps.npm-publish.outputs.version }}
+          body: ${{ steps.npm-publish.outputs.version }} Release
+          draft: false
+          prerelease: false

README.md

@@ -148,3 +148,9 @@ following depending on the configs you enable:
 * eslint-plugin-react-hooks
 * eslint-plugin-import
 * typescript
+
+## Releasing
+
+Use "[Run workflow](https://github.com/matrix-org/eslint-plugin-matrix-org/actions/workflows/release.yaml)".
+Refer to [SemVer](https://semver.org/) for versioning semantics.
+This workflow will bump the version, publish NPM, and create a GitHub release.