Merge pull request #3135 from scratchfoundation/implement-semantic-re…

…lease

Implement semantic release

.eslintrc

@@ -50,7 +50,8 @@
         "no-constant-condition": ["off"]
     },
     "env": {
-        "browser": true
+        "browser": true,
+        "es6": true
     },
     "globals": {
         "Blockly": true, # Blockly global

.github/workflows/commitlint.yml

@@ -0,0 +1,12 @@
+name: Lint commit messages
+on: [pull_request]
+
+concurrency:
+  group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.sha }}"
+
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: wagoid/commitlint-github-action@v5

.github/workflows/deploy.yml

@@ -1,13 +1,13 @@
 name: build-scratch-blocks
-on: 
-    push: 
-        branches: [master, develop, beta, hotfix/*]
+on:
+    push: # Runs whenever a commit is pushed to the repository
+    workflow_dispatch: # Allows you to run this workflow manually from the Actions tab
 jobs:
     setup:
       runs-on: ubuntu-latest
       env:
         JVM_OPTS: -Xmx3200m
-        DETECT_CHROMEDRIVER_VERSION: true 
+        DETECT_CHROMEDRIVER_VERSION: true
         PROJECT_PATH: ./scratch-blocks
       steps:
         - uses: actions/checkout@v3
@@ -16,7 +16,7 @@ jobs:
             sudo apt-get update
             sudo apt-get install -y libgconf-2-4 libatk1.0-0 libatk-bridge2.0-0 libgdk-pixbuf2.0-0 libgtk-3-0 libgbm-dev libnss3-dev libxss-dev libasound2
         - name: Check Python version
-          run: python --version 
+          run: python --version
         - name: Setup Java
           uses: actions/setup-java@v3
           with:
@@ -50,24 +50,8 @@ jobs:
             publish_dir: ./gh-pages
             full_commit_message: "Build for ${{ github.sha }} ${{ github.event.head_commit.message }}"
             enable_jekyll: true
-        - name: Deploy to npm
-          if: (github.ref == 'refs/heads/master') || (github.ref == 'refs/heads/develop') || startsWith(github.ref, 'refs/heads/hotfix') || startsWith(github.ref, 'refs/heads/release') || startsWith(github.ref, 'refs/heads/beta')
-          run: |
-           export RELEASE_VERSION="0.2.0-prerelease.$(date +'%Y%m%d%H%M%S')"
-            if [[ "${{contains(github.ref, 'hotfix')}} ]]; then
-            export NPM_TAG=hotfix
-            elif [[ "${{contains(github.ref, 'beta')}} ]]; then
-            export NPM_TAG=beta
-            else
-            export NPM_TAG=latest
-            fi
-            echo "Deploying version $RELEASE_VERSION to $NPM_TAG"
-            npm --no-git-tag-version version $RELEASE_VERSION
-            npm set //registry.npmjs.org/:_authToken=${{secrets.NPM_TOKEN}}
-            npm publish --tag $NPM_TAG
-            if npm info | grep -q $RELEASE_VERSION; then
-            git tag $RELEASE_VERSION
-            git push \
-                https://${{secrets.GITHUB_TOKEN}}@github.com/${{github.repository}}.git \
-                $RELEASE_VERSION
-            fi
+        - name: Run semantic-release
+          env:
+            NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          run: npx --no -- semantic-release

.husky/.gitattributes

@@ -0,0 +1 @@
+* text eol=lf

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit "$1"

README.md

@@ -19,3 +19,20 @@ The "getting started" guide including [FAQ](https://scratch.mit.edu/developers#f
 
 ## Donate
 We provide [Scratch](https://scratch.mit.edu) free of charge, and want to keep it that way! Please consider making a [donation](https://secure.donationpay.org/scratchfoundation/) to support our continued engineering, design, community, and resource development efforts. Donations of any size are appreciated. Thank you!
+
+## Committing
+
+This project uses [semantic release](https://github.com/semantic-release/semantic-release) to ensure version bumps
+follow semver so that projects depending on it don't break unexpectedly.
+
+In order to automatically determine version updates, semantic release expects commit messages to follow the
+[conventional-changelog](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md)
+specification.
+
+You can use the [commitizen CLI](https://github.com/commitizen/cz-cli) to make commits formatted in this way:
+
+```bash
+npm install -g commitizen@latest cz-conventional-changelog@latest
+```
+
+Now you're ready to make commits using `git cz`.

commitlint.config.js

@@ -0,0 +1,5 @@
+/* global module */
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  ignores: [message => message.startsWith('chore(release):')]
+};