Semantic Release 🚀

Description

fast-alfred CI / CD template recommends you work with semantic-release.

At the end of this process, you'd be able to publish your Workflow into GitHub Releases, with a versioning system based on your commits.

Installation

npm install -D semantic-release @semantic-release/{changelog,commit-analyzer,exec,git,github,release-notes-generator}

TIP ⚡

It is very recommended to use tools for commit message enforcement like commitlint

Setup

NOTE ⚠️

Fill in the upper case placeholders with your own values, such as REPO_NAME, WORKFLOW_NAME, etc.

In case you've changed the targetDir over the bundler options, you should change the @semantic-release/github asset path accordingly.

Create a .releaserc file in the root of your project and add the following configuration:

.releaserc

{
    "$schema": "https://json.schemastore.org/semantic-release.json",
    "repositoryUrl": "https://github.com/REPO_FULL_NAME.git",
    "branches": [
        "+([0-9])?(.{+([0-9]),x}).x",
        "master",
        "next",
        "next-major",
        {
            "name": "beta",
            "prerelease": true
        },
        {
            "name": "alpha",
            "prerelease": true
        }
    ],
    "tagFormat": "v${version}",
    "plugins": [
        "@semantic-release/commit-analyzer",
        "@semantic-release/release-notes-generator",
        [
            "@semantic-release/changelog",
            {
                "changelogFile": "CHANGELOG.md"
            }
        ],
        [
            "@semantic-release/exec",
            {
                "prepareCmd": "npx fast-alfred -t ${nextRelease.version}"
            }
        ],
        [
            "@semantic-release/git",
            {
                "assets": ["package.json", "package-lock.json", "info.plist", "CHANGELOG.md"],
                "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
            }
        ],
        [
            "@semantic-release/github",
            {
                "assets": [
                    {
                        "path": "./esbuild/WORKFLOW_NAME.alfredworkflow",
                        "label": "WORKFLOW_NAME.alfredworkflow",
                        "name": "WORKFLOW_NAME.alfredworkflow"
                    }
                ]
            }
        ]
    ]
}