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

Chore: Create an issue template for new releases #464

Merged
merged 1 commit into from
Jun 20, 2024

Conversation

lalver1
Copy link
Member

@lalver1 lalver1 commented Jun 13, 2024

Closes #433

This PR creates an issue form template for new releases.

@lalver1 lalver1 self-assigned this Jun 13, 2024
Copy link

Coverage report

This PR does not seem to contain any modification to coverable code.

@lalver1 lalver1 changed the title Chore: Create an issue template for releases Chore: Create an issue template for new releases Jun 13, 2024
@lalver1 lalver1 added the chore Chores and tasks for code cleanup, dev experience, etc. label Jun 13, 2024
@lalver1
Copy link
Member Author

lalver1 commented Jun 13, 2024

One small thing to note is that this template's checklist contains an item for the release candidate and another for the regular release. This may cause confusion about what to use in the title of the ticket (Make a Release: YYYY.0M.R or Make a Release: YYYY.0M.-rcR ), but it should be clear that the ticket should have the regular release version in the title, not the release candidate version.

We could add Release Type to the form (similar to benefits but with release-candidate and release instead of Regular and Hotfix) but it seems too much to have to create two separate issues, one for release candidates and one for releases.

@lalver1 lalver1 marked this pull request as ready for review June 13, 2024 17:08
@lalver1 lalver1 requested a review from a team as a code owner June 13, 2024 17:08
@thekaveman
Copy link
Member

...it should be clear that the ticket should have the regular release version in the title, not the release candidate version.

...it seems too much to have to create two separate issues, one for release candidates and one for releases.

Yeah we definitely don't want two separate issues! Since the checklist includes an item for making a release candidate, I think you're right and we're good with just the one template as-is.

Copy link
Member

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

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

@lalver1, can you see if it is possible to have a description / body in the issue that gets created?

E.g. it would be great if the text of the markdown field showed up in the issue, not just in the form for creating an issue from the template.

@lalver1
Copy link
Member Author

lalver1 commented Jun 18, 2024

That would be nice @thekaveman, I tried a few things on a test repo but unfortunately I couldn't get the text of the markdown field to show up in the issue; it looks like value is the only key you can set under attributes. So I also tried with the other types of form elements (textarea, checkboxes, etc.) but there wasn't anything I could use to get the behavior we want.

Copy link
Member

@angela-tran angela-tran left a comment

Choose a reason for hiding this comment

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

This looks great to me! It'll be so nice to use this rather than the copy-pasting we've been doing.

@lalver1 lalver1 merged commit 2a14652 into main Jun 20, 2024
7 checks passed
@lalver1 lalver1 deleted the chore/issue-template-release branch June 20, 2024 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Chores and tasks for code cleanup, dev experience, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create an issue template for new releases
3 participants