README.md

📦 @scaleleap/semantic-release-config

Semantic Release shareable config to publish NPM packages with GitHub.

---

Plugins

This shareable configuration uses the following plugins:

• @semantic-release/commit-analyzer
• @semantic-release/release-notes-generator
• @semantic-release/npm
• @semantic-release/github
• @semantic-release/git

Summary

• Provides an informative git commit message for the release commit that does not trigger continuous integration and conforms to the conventional commits specification (e.g., "chore(release): 1.2.3 [skip ci]\n\nnotes").
• Creates a tarball that gets uploaded with each GitHub release.
• Publishes the same tarball to NPM.
• Commits the version change in package.json.
• Creates or updates a changelog file.

Running in CI

$> npx @scaleleap/semantic-release-config

Usage

The shareable config can be configured in the semantic-release configuration file:

In package.json:

{
  "release": {
    "extends": "@scaleleap/semantic-release-config"
  }
}

Configuration

Ensure that your CI configuration has the following secret environment variables set:

• GH_TOKEN with public_repo access.
• NPM_TOKEN
• NODE_AUTH_TOKEN
• SLACK_WEBHOOK Optional

See each plugin documentation for required installation and configuration steps.

Contributing

This repository uses Conventional Commit style commit messages.

Authors or Acknowledgments

• Roman Filippov (Scale Leap)

License

This project is licensed under the MIT License.

Badges