-
-
Notifications
You must be signed in to change notification settings - Fork 572
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding comments to Update .releaserc.js (#494)
Adding comments helps to explain the purpose of each section and plugin in your Semantic Release configuration.
- Loading branch information
1 parent
75f585a
commit 42ff311
Showing
1 changed file
with
20 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,48 @@ | ||
// Export a configuration object for Semantic Release | ||
|
||
module.exports = { | ||
// Define the branch to release from (e.g., "main" branch) | ||
branches: [{ name: "main" }], | ||
|
||
// List of plugins used for the release process | ||
plugins: [ | ||
// Plugin to analyze commit messages following the Angular commit convention | ||
[ | ||
"@semantic-release/commit-analyzer", | ||
{ | ||
preset: "angular", | ||
preset: "angular", // Use the Angular preset | ||
}, | ||
], | ||
// Plugin to generate release notes | ||
"@semantic-release/release-notes-generator", | ||
// Plugin to update the changelog | ||
"@semantic-release/changelog", | ||
// Plugin to commit changes to the repository | ||
[ | ||
"@semantic-release/git", | ||
{ | ||
// Specify files to commit as part of the release | ||
assets: ["CHANGELOG.md", "package.json", "yarn.lock"], | ||
// Define the commit message format | ||
message: "chore(release): 🤖 ${nextRelease.version} [skip ci]", | ||
}, | ||
], | ||
// Plugin to create a GitHub release | ||
[ | ||
"@semantic-release/github", | ||
{ | ||
// Specify assets to upload with the release | ||
assets: ["CHANGELOG.md"], | ||
}, | ||
], | ||
], | ||
|
||
// Use the Angular preset for commit message parsing | ||
preset: "angular", | ||
|
||
// Enable CI mode (disables prompts and prevents publishing) | ||
ci: true, | ||
|
||
// Enable debug mode for more verbose output | ||
debug: true, | ||
}; |