Skip to content

Sonia-corporation/conventional-changelog

Repository files navigation

Sonia Conventional Changelog

Sonia Conventional Changelog for Semantic Release

Quality:
GitHub last commit GitHub issues GitHub pull requests Release Dependencies Dev Dependencies semantic-release code style: prettier

Community:
All Contributors commitizen PRs

Statistics:
GitHub release (latest by date) GitHub top language GitHub repo size GitHub code size in bytes GitHub

Sonia Conventional Changelog

Based on conventional-changelog-angular.

Additional features

  • Emojis in front of the section titles
  • Display the commit's body
  • Filter which type of commits should appear

Filtering which type of commits should appear

You can define which type of commit should appear in your changelog.
To do that, pass the types option to the presetConfig with the list of commit types.

Example:

[
      "@semantic-release/release-notes-generator",
      {
        "config": "@sonia-corporation/conventional-changelog",
        "parserOpts": {
          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
        },
        "writerOpts": {
          "commitsSort": ["subject", "scope"],
          "owner": "C0ZEN"
        },
        "linkCompare": true,
        "linkReferences": true,
        "includeDetails": true,
        "commit": "commit",
        "issue": "issues",
        "presetConfig": {
          "types": ["feat", "fix", "perf", "docs", "revert"]
        }
      }
    ],

Contributing

Check out the contributing file before helping us.

License

This project is licensed under the MIT License - see the license for details.

Contributors

Thanks goes to these wonderful people (emoji key):


Geoffrey 'C0ZEN' Testelin

💻 🎨 🚇 🤔 📝 📖 🔧 🛡️ 👀 💬 🚧 🐛

All Contributors

📖 🔧

WhiteSource Renovate

🔧 🛡️

Semantic Release Bot

📖 🔧 🛡️

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