Skip to content
This repository has been archived by the owner on Jul 12, 2022. It is now read-only.

feat: Support custom templates for commits + PRs #1048

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

CrispyDrone
Copy link
Contributor

✨ What kind of change does this PR introduce? (Bug fix, feature, docs update...)

Feature.

⤵️ What is the current behavior?

All commit messages, and pull request title and body templates are hardcoded.

🆕 What is the new behavior (if this is a feature change)?

This commit introduces mustache templates for commit messages, and pull
request titles and bodies.

The design consists of templates with predefined properties. A custom
template can be provided.

Stubble has been chosen as the template renderer.

It is possible to define additional context for the templates, this also
includes delegates. These can be provided as the value of a "_delegates"
key in the context.

💥 Does this PR introduce a breaking change?

No.

🐛 Recommendations for testing

Creation of pull requests and commits.

📝 Links to relevant issues/docs

N/A

🤔 Checklist before submitting

  • All projects build
  • Relevant documentation was updated

@clooudch
Copy link

clooudch commented Nov 7, 2020

will this feature be merged?

@csMACnz
Copy link

csMACnz commented Dec 21, 2020

I am very interested in the ability to set custom templates for commit messages and PR titles. We have a requirement to put a JIRA ticket number in both of these places.

@caffeineinc
Copy link

I'm also interested in this; seems like a relatively small change too!

This commit introduces mustache templates for commit messages, and pull
request titles and bodies.

The design consists of templates with predefined properties. A custom
template can be provided.

Stubble has been chosen as the template renderer.

It is possible to define additional context for the templates, this also
includes delegates. These can be provided as the value of a "_delegates"
key in the context.
@CrispyDrone
Copy link
Contributor Author

Rebased to incorporate new changes on master and fix conflicts.

@stale
Copy link

stale bot commented Apr 23, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Apr 23, 2021
@csMACnz
Copy link

csMACnz commented Apr 23, 2021

Heya, what needs done to get this functionality added? This still remains a dealbreaker of using this tool for us.

@stale stale bot removed the wontfix label Apr 23, 2021
@msallin
Copy link
Member

msallin commented Jun 5, 2021

We are very interested in having custom commit messages, as we are using conventional commits to automatically set our version.

We are able to invest time into this feature. How to go on with this PR? What's missing? How can we help?

@msallin
Copy link
Member

msallin commented Aug 23, 2021

Any news? Still ready to help, if necessary.

cc org members: @slang25 @shep1987 @MarcBruins @AnthonySteele

@msallin
Copy link
Member

msallin commented Aug 28, 2021

For those which are looking for the corresponding issue (closed because of inactivity): #897

@msallin msallin self-assigned this Sep 16, 2021
@msallin
Copy link
Member

msallin commented Sep 20, 2021

@CrispyDrone can you please rebase the branch on the latest master?

@stale
Copy link

stale bot commented Dec 20, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Dec 20, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants