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

Template variables support for release-pr branch name #1991

Open
AdamStrojek opened this issue Jan 14, 2025 · 1 comment
Open

Template variables support for release-pr branch name #1991

AdamStrojek opened this issue Jan 14, 2025 · 1 comment
Labels
enhancement New feature or request

Comments

@AdamStrojek
Copy link

Motivations

Currently we can provide static text as pr_branch_prefix in config file. This solution is not that flexible, and requires using suggested branch naming strategy. I think it would be better to replace it with template system that allows you on providing such configuration:

[workspace]
pr_branch_template = "release/v{{ version }}"

If somebody wants to remain current behavior we can leave pr_branch_prefix as legacy option that would automatically be interpreted as:

[workspace]
pr_branch_template = "{{ pr_branch_prefix }}-tmp-{{ date }}"

If instructed I can implement this feature

@AdamStrojek AdamStrojek added the enhancement New feature or request label Jan 14, 2025
@marcoieni
Copy link
Member

I agree with you that pr_branch_template is better than pr_branch_prefix.
The issue is that release-plz in workspaces has more {{ version }}s. What should release-plz put in that variable in this case?

Plus, the version could change (e.g. because there's a new breaking change and so instead of 0.4.1 is now 0.5.0). The branch will change so release-plz needs to close and open a new PR. So much complexity added! Is it worth it? Why is the current prefix not good enough for your purposes?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants