# Semantic Release This file lists machine-readable Markdown pages for this docs site. ## Pages - [Introduction](https://semantic-release.org/intro.md) - Learn how semantic-release automates versioning, changelogs, and publishing using commit messages and CI. ## Usage - [Getting started](https://semantic-release.org/usage/getting-started.md) - Get started with semantic-release: install dependencies, configure CI, and publish your first automated release. - [Configuration](https://semantic-release.org/usage/configuration.md) - Learn all semantic-release configuration options, including branches, plugins, and repository settings. - [CI Configuration](https://semantic-release.org/usage/ci-configuration.md) - Configure CI so semantic-release runs only on release branches with the required credentials. - [Running semantic-release](https://semantic-release.org/usage/running.md) - Run semantic-release locally or in CI, understand dry runs, and interpret release logs. ## Foundations - [Foundations](https://semantic-release.org/foundation.md) - Start with semantic-release foundations: core concepts, release flow, plugins, and branching strategy. - [How it Works](https://semantic-release.org/foundation/how-it-works.md) - Understand how semantic-release analyzes commits, calculates versions, and publishes releases automatically. - [Release Steps](https://semantic-release.org/foundation/release-steps.md) - Explore the release lifecycle steps semantic-release runs from verification to publishing and notifications. - [Considerations](https://semantic-release.org/foundation/considerations.md) - Evaluate whether semantic-release and semantic versioning fit your project goals, artifacts, and release process. - [Supported Branching Models](https://semantic-release.org/foundation/supported-branching.md) - See supported branching models and channel strategies for stable, maintenance, and pre-release lines. - [Release Workflow Configuration](https://semantic-release.org/foundation/workflow-configuration.md) - Configure release branches, channels, and rules that control the semantic-release workflow. - [Plugins](https://semantic-release.org/foundation/plugins.md) - Learn how semantic-release plugins execute each release step and how to combine them effectively. - [Shareable Configurations](https://semantic-release.org/foundation/shareable-configurations.md) - Understand shareable configurations in semantic-release and how they simplify reusable setup. ## Extending - [Plugins](https://semantic-release.org/extending/plugins-list.md) - Extend semantic-release with official and community plugins for publishing, notifications, and more. - [Shareable configuration](https://semantic-release.org/extending/shareable-configurations-list.md) - Browse community shareable configurations for semantic-release and find setups for common workflows. ## CI Configurations - [CI configurations](https://semantic-release.org/recipes/ci-configurations.md) - Compare CI configuration examples for running semantic-release across popular providers. - [GitHub Actions](https://semantic-release.org/recipes/ci-configurations/github-actions.md) - Configure semantic-release in GitHub Actions with trusted workflow permissions and release safeguards. - [GitLab CI](https://semantic-release.org/recipes/ci-configurations/gitlab-ci.md) - Run semantic-release in GitLab CI with protected variables and a release stage in your pipeline. - [CircleCI 2.0](https://semantic-release.org/recipes/ci-configurations/circleci-workflows.md) - Set up semantic-release on CircleCI 2.0 with secure tokens and a reliable release job pipeline. - [Travis CI](https://semantic-release.org/recipes/ci-configurations/travis.md) - Use semantic-release with Travis CI to automate versioning and publication from your release branch. - [Jenkins CI](https://semantic-release.org/recipes/ci-configurations/jenkins-ci.md) - Configure semantic-release on Jenkins CI, including environment variables and non-interactive authentication. ## Git Hosted Services - [Git hosted services](https://semantic-release.org/recipes/git-hosted-services.md) - Recipes for integrating semantic-release with Git-hosted services and authentication methods. - [Git authentication with SSH keys](https://semantic-release.org/recipes/git-hosted-services/git-auth-ssh-keys.md) - Configure Git authentication with SSH keys so semantic-release can push tags and notes securely. ## Release Workflow - [Release Workflow](https://semantic-release.org/recipes/release-workflow.md) - Release workflow recipes for channels, maintenance releases, and pre-releases with semantic-release. - [Publishing on distribution channels](https://semantic-release.org/recipes/release-workflow/distribution-channels.md) - Publish semantic-release versions to distribution channels such as npm dist-tags and maintenance lines. - [Publishing maintenance releases](https://semantic-release.org/recipes/release-workflow/maintenance-releases.md) - Publish maintenance releases from support branches while continuing development on main. - [Publishing pre-releases](https://semantic-release.org/recipes/release-workflow/pre-releases.md) - Configure semantic-release pre-releases for beta, alpha, and next channels before stable promotion. ## Developer Guide - [JavaScript API](https://semantic-release.org/developer-guide/js-api.md) - Reference the JavaScript API to run semantic-release programmatically and integrate custom release workflows. - [Plugin development](https://semantic-release.org/developer-guide/plugin.md) - Build semantic-release plugins by implementing lifecycle steps and handling release context safely. - [Shareable configuration development](https://semantic-release.org/developer-guide/shareable-configuration.md) - Create and publish shareable semantic-release configurations to reuse release rules across projects. ## Support - [Resources](https://semantic-release.org/support/resources.md) - Explore official semantic-release resources, plugins, guides, and community links. - [Troubleshooting](https://semantic-release.org/support/troubleshooting.md) - Resolve common semantic-release errors related to permissions, tags, branches, and CI configuration. - [Node version requirement](https://semantic-release.org/support/node-version.md) - Verify Node.js version requirements needed to execute semantic-release in CI. - [Node Support Policy](https://semantic-release.org/support/node-support-policy.md) - Review the Node.js support policy and maintenance window followed by semantic-release. - [Git version requirement](https://semantic-release.org/support/git-version.md) - Check the minimum Git version required to run semantic-release features reliably. ## Other Pages - [Automate your release with semantic-release.](https://semantic-release.org/index.md) - Fully automated version management and package publishing. - [Frequently Asked Questions](https://semantic-release.org/support/FAQ.md) - Find quick answers to common semantic-release questions about setup, behavior, and best practices.