Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add includeCommitId option #325

Merged
merged 2 commits into from
Jun 21, 2022
Merged

feat: add includeCommitId option #325

merged 2 commits into from
Jun 21, 2022

Conversation

rufman
Copy link
Contributor

@rufman rufman commented Jun 17, 2022

Description

Add the option includeCommitId, which prints the short commit id in
the changelog without including the link to the commit.

This allows users of git repositories that are not GitHub or GitLab to
have the commit sha present in the changelog instead of just the commit
message.

If both includeCommitId and linkToCommits are set to true, commit
linking takes presidence.

Type of Change

  • feat -- New feature (non-breaking change which adds functionality)
  • 🛠️ fix -- Bug fix (non-breaking change which fixes an issue)
  • ! -- Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 refactor -- Code refactor
  • ci -- Build configuration change
  • 📝 docs -- Documentation
  • 🗑️ chore -- Chore

Add the option `includeCommitId`, which prints the short commit id in
the changelog without including the link to the commit.

This allows users of git repositories that are not GitHub or GitLab to
have the commit sha present in the changelog instead of just the commit
message.

If both `includeCommitId` and `linkToCommits` are set to true, commit
linking takes presidence.
@CLAassistant
Copy link

CLAassistant commented Jun 17, 2022

CLA assistant check
All committers have signed the CLA.

Copy link
Collaborator

@blaugold blaugold left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this! This looks all good. Please also document the new option here.

Copy link
Collaborator

@blaugold blaugold left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@blaugold blaugold requested a review from Salakar June 21, 2022 09:43
@blaugold blaugold merged commit e981adf into invertase:main Jun 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants