Skip to content

Semantic Release shareable configuration for logdna node packages

License

Notifications You must be signed in to change notification settings

logdna/semantic-release-config-logdna

Repository files navigation

semantic-release-config-logdna

All Contributors

semantic-release

Semantic Release shareable configuration for logdna node packages

Baseline shareable semantic-release configuration for logdna node packages. This configuration pre-configures the commits parser and release notes.

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

Installation

$ npm install --save-dev semantic-release semantic-release-config-logdna
// package.json
{
  "release": {
    "branches": ["main"],
    "extends": "semantic-release-config-logdna"
  }
}

Features

  • Parse un-merged commits to determine next release version
    • The version number is dictated by the commit with the highest semver level
  • Increments the version of package.json
  • Generates + updates Changelog
    • Includes github issue links for defined issue Keys (close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved, ref)
    • Includes links to commit sha
    • Organizes changes by type
  • Commits standardized release commit back upstream
  • Attaches any build artifacts placed in ./dist to the release

Commit Types

Commit Type Changelog Category
feat Features
fix Bug Fixes
perf Performance Improvements
revert Reverts
doc Documentation
refactor Code Refactoring
test Tests
build Build System
ci Continuous Integration
chore Chores
<default> Miscellaneous

Authors

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Eric Satterwhite

📖 💻 ⚠️ 🚧

Mike Del Tito

📖 💻

This project follows the all-contributors specification. Contributions of any kind welcome!