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

[FEATURE] - configurable bump commit message #376

Open
3 tasks
oknozor opened this issue Mar 4, 2024 · 0 comments
Open
3 tasks

[FEATURE] - configurable bump commit message #376

oknozor opened this issue Mar 4, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@oknozor
Copy link
Collaborator

oknozor commented Mar 4, 2024

Is your feature request related to a problem? Please describe.
When creating a bump, a version commit is created with the following format chore(version): 6.0.1, users might want to use a different format.

Describe the solution you'd like
The version commit should be configurable in cog.toml and support version dsl.

Example:

version_commit = """
release({{version_tag}}): Bumped version from {{latest}} to {{version}}

A commit body

foo #bar 
"""

Additionally we should be able to override version commit using the CLI.
Since its probably something people want to automate, we should be able to write
The whole conventional commit (summary, body and footer) without $EDITOR.

This imply adding several arguments to the bump command to construct the version commit message

  • summary + scope: should be a single string input, ex: chore({{version}}): bump version
  • body : a single multi-line string
  • footers: an array of key value pair

Describe alternatives you've considered
Port the cog commit --edit flag to the bump command. This could be added as well but it's probably not as useful as having a dedicated flag since it requires manual editing.

Additional context
This was fist proposed as a single flag to override the version commit scope (see: #375) which is a good idea but does not cover all possible use cases.

@oknozor oknozor added the enhancement New feature or request label Mar 4, 2024
@oknozor oknozor self-assigned this Mar 4, 2024
@oknozor oknozor added the good first issue Good for newcomers label Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant