ed89361d7c
**Refactor and clarify the documentation in `README.md`** - Add Highlights - Add a Table of contents - Clarify the way semantic-release works - Clarify relationship with the CI environments - Describe local install for Node projects (with a `package.json`) and global install for non-JavaScript projects - Explain CI general configuration (environment variables and a run after all jobs are successful) - Clarify configuration (via config file or CLI arguments) - Clarify plugin roles and configuration - Add doc for shareable configuration - Add recipes - Add resources (Videos, articles, tutorials) - Add a Support section - Add a Team section **Add the following FAQs** - How can I use a npm build script that requires the `package.json`’s version ? - Can I use Semantic-release with Yarn? - Can I use Semantic-release to publish non-JavaScript packages? - Can I use Semantic-release with any CI service? - Can I use Semantic-release with any GitLab? - Can I use Semantic-release with any Git hosted environment? - Can I skip the release to the npm registry? - Can I use .npmrc options? - How can I set the access level of the published npm package? - Can I use Semantic-release to publish a package on Artifactory? - Can I set the initial release version of my package to 0.0.1? - Why does semantic-release require Node version >= 8? **Clarify Nove 8 requirement and solutions** - Add Node version requirement explanation and solutions - [X] Display a link to the documentation when running on Node < 8 version **Add recipes** - Travis - GitLab CI - Travis with build stages - To be done in #573 - CircleCI workflows - To be done in #573
3.1 KiB
3.1 KiB
semantic-release plugins
Default plugins
-
- verifyConditions: Verify the presence and the validity of the GitHub authentication and release configuration
- publish: Publish a GitHub release
-
- verifyConditions: Verify the presence and the validity of the npm authentication and release configuration
- getLastRelease: Determine the last release of the package on the npm registry
- publish: Publish the package on the npm registry
Official plugins
-
- verifyConditions: Verify the presence and the validity of the GitLab authentication and release configuration
- publish: Publish a GitLab release
-
- verifyConditions: Verify the presence and the validity of the Git authentication and release configuration
- getLastRelease: Determine the last release via Git tags on the repository
- publish: Push a release commit and tag, including configurable files
-
- verifyConditions: Verify the presence and the validity of the configuration
- publish: Create or update the changelog file in the local project repository
-
- verifyConditions: Execute a shell command to verify if the release should happen
- getLastRelease: Execute a shell command to determine the last release
- analyzeCommits: Execute a shell command to determine the type of release
- verifyRelease: Execute a shell command to verifying a release that was determined before and is about to be published.
- generateNotes: Execute a shell command to generate the release note
- publish: Execute a shell command to publish the release.