Was Sie erreichen werden

Sie werden automatisierte Versionsanhebungen und Changelog-Generierung einrichten, gesteuert durch Conventional Commits.

Der Mechanismus

Tooling liest Commit-Nachrichten, die dem Conventional-Commits-Format folgen.

Schritt 1: Conventional Commits ubernehmen

git commit -m "feat(checkout): add Apple Pay support"
git commit -m "fix(auth): handle expired refresh tokens"
git commit -m "chore(deps): bump axios to 1.7.0"
git commit -m "feat!: drop Node 16 support

BREAKING CHANGE: minimum Node version is now 18."

Schritt 2: das Format durchsetzen

npm install --save-dev @commitlint/cli @commitlint/config-conventional husky

# commitlint.config.js
module.exports = { extends: ['@commitlint/config-conventional'] };

# .husky/commit-msg
#!/usr/bin/env sh
. "$(dirname "$0")/_/husky.sh"
npx --no -- commitlint --edit $1

Schritt 3: Release-Tooling installieren

# .github/workflows/release-please.yml
name: release-please
on:
  push:
    branches: [main]
permissions:
  contents: write
  pull-requests: write
jobs:
  release-please:
    runs-on: ubuntu-latest
    steps:
      - uses: googleapis/release-please-action@v4
        with:
          release-type: node
          package-name: my-app

Schritt 4: wie release-please funktioniert

1. Liest Commits seit dem letzten Release-Tag.
2. Kategorisiert nach Typ und entscheidet die nachste Version.
3. Aktualisiert CHANGELOG.md und package.json-Version.
4. Offnet eine "Release-PR".

Schritt 5: den Publish-Workflow auslosen

# .github/workflows/publish.yml
name: publish
on:
  push:
    tags: ['v*.*.*']
jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
          registry-url: 'https://registry.npmjs.org'
      - run: npm ci
      - run: npm run build
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

Schritt 6: Alternative - changesets

npm install --save-dev @changesets/cli
npx changeset init

Schritt 7: Alternative - semantic-release

npm install --save-dev semantic-release
# .releaserc.json
{
  "branches": ["main"],
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "@semantic-release/changelog",
    "@semantic-release/npm",
    "@semantic-release/github",
    "@semantic-release/git"
  ]
}

Schritt 8: Pre-Releases

git checkout -b beta
git push -u origin beta

{
  "branches": ["main", { "name": "beta", "prerelease": true }]
}

Schritt 9: gute Commit-Nachrichten schreiben

feat(checkout): add Apple Pay support

Implements Apple Pay via the Web Payments API. Falls back to the
existing card flow if Apple Pay is unavailable. Closes #1234.

Schritt 10: Squashes handhaben

- uses: amannn/action-semantic-pull-request@v5
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}