DevOps Help

Release

Prerequisites

Consuming the workflow

jobs: release: uses: kurocado-studio/dev-ops/.github/workflows/workflow.release.yml@main secrets: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} NPM_TOKEN: ${{ secrets.NPM_TOKEN }} with: branch_name: ${{ github.ref_name }}

Overview

Automates the release process, including versioning, changelog generation, and release notes.

GitHub RepositoryGitHub Actions RunnerSemantic ReleaseSemantic Release PluginsGitHub APINPM Registryalt[Repository uses semantic-release.npm]alt[Release Needed]alt[Workflow Successful][Workflow Failed]Trigger Release WorkflowCheckout RepositoryInstall DependenciesRun Semantic ReleaseLoad "@semantic-release/changelog"Load "@semantic-release/github"Load "@semantic-release/npm"Load "@semantic-release/commit-analyzer"Load "@semantic-release/release-notes-generator"analyzeCommits ("@semantic-release/commit-analyzer")Determine release typegenerateNotes ("@semantic-release/release-notes-generator")Release notes generatedprepare changelog ("@semantic-release/changelog")CHANGELOG.md updatedCreate Git tagPublish GitHub releaseGitHub release publishedPublish to NPM ("@semantic-release/npm")Publish confirmedNotify successReport Workflow SuccessUpdate Status as SuccessfulReport Workflow FailureUpdate Status with ErrorsGitHub RepositoryGitHub Actions RunnerSemantic ReleaseSemantic Release PluginsGitHub APINPM Registry
Last modified: 25 March 2025