Merge pull request #42 from modelix/feature/semantic-releases

Implement automated releases

Author: languitar

.github/workflows/release.yml

@@ -0,0 +1,75 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+
+jobs:
+  lint-commits:
+    name: Lint PR commits
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'pull_request' }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: wagoid/commitlint-github-action@v5
+
+  test-release:
+    name: Dry-run semantic-release
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'pull_request' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Checkout branch
+        # Pretend to semantic-release that the PR result is eligible for
+        # building releases because --dry-run still filters for configured
+        # branches.
+        run: git checkout -b main
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Cache Node packages
+        uses: actions/cache@v3
+        with:
+          path: node_modules
+          key: release-${{ hashFiles('package.json') }}-${{ hashFiles('package-lock.json') }}
+      - name: Install dependencies
+        run: npm ci
+      - name: Dry-run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        # We need to convince semantic-release to not pick up some
+        # configuration from the CI environment by removing the variable that
+        # is used for CI detection.
+        run: unset GITHUB_ACTIONS && npx semantic-release --dry-run --ci false
+
+  release:
+    name: Run semantic release
+    runs-on: ubuntu-latest
+    if: ${{ github.ref == 'refs/heads/main' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Cache Node packages
+        uses: actions/cache@v3
+        with:
+          path: node_modules
+          key: release-${{ hashFiles('package.json') }}-${{ hashFiles('package-lock.json') }}
+      - name: Install dependencies
+        run: npm ci
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx semantic-release

.gitignore

@@ -7,3 +7,4 @@
 *.iml
 kotlin_gen
 /version.txt
+/node_modules

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+---
+default_install_hook_types:
+  - pre-commit
+  - commit-msg
+repos:
+  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
+    rev: v9.4.0
+    hooks:
+      - id: commitlint
+        stages: [commit-msg]
+        additional_dependencies: ["@commitlint/config-angular"]
+        args: ["--config", "./commitlint.config.js"]

.releaserc.json

@@ -0,0 +1,21 @@
+{
+  "branches": [
+    "main"
+  ],
+  "tagFormat": "${version}",
+  "plugins": [
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "preset": "conventionalcommits"
+      }
+    ],
+    [
+      "@semantic-release/release-notes-generator",
+      {
+        "preset": "angular"
+      }
+    ],
+    "@semantic-release/github"
+  ]
+}

README.md

@@ -1,2 +1,19 @@
 # modelix.core
+
 All the Modelix components that don't have a dependency on JetBrains MPS
+
+## Development
+
+### Commit convention
+
+This project uses [conventional commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/) as the convention for Git commits.
+
+### pre-commit
+
+This project uses [pre-commit](https://pre-commit.com/) to validate that new commits follow intended conventions.
+To enable pre-commit hooks, you have to run the following command initially after cloning the repository:
+
+```console
+$ pre-commit install
+pre-commit installed at .git/hooks/pre-commit
+```

commitlint.config.js

@@ -0,0 +1,20 @@
+module.exports = {
+  extends: ["@commitlint/config-conventional"],
+  rules: {
+    "scope-enum": [
+      2,
+      "always",
+      [
+        "light-model-client",
+        "light-model-server",
+        "metamodel-export-mps",
+        "metamodel-generator",
+        "metamodel-gradle",
+        "model-api",
+        "model-client",
+        "model-server",
+        "ts-model-api",
+      ],
+    ],
+  },
+};