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

Release Notes: Ignore Issue Title if there are release notes written within a given ticket #40

Open
lsulak opened this issue May 28, 2024 · 4 comments
Labels
enhancement New feature or request
Milestone

Comments

@lsulak
Copy link

lsulak commented May 28, 2024

Background

Ignore Issue title if a given Issue has Release Notes in it. I find this to potentially improve the readability of our Releases - let's keep the information brief but detailed enough and tidy.

Or even better, make it configurable.

Example

Imagine that you have tickets 111 and 112, as detailed below.

Ticket 111 (author A1 worked on it)

Title: Implement Algorithm BFS for problem X

Release Notes

  • BFS implemented for problem X
  • Optimized the backend part Y by Z amount of % on average

Ticket 112 (author A2 worked on it)

Title: Enhancing Monitoring of the service Q

(and this ticket would have no release notes)


Final Release Draft would look like this:

...

New Features 🎉

  • #111 by @ A1

    • BFS implemented for problem X
    • Optimized the backend part Y by Z amount of % on average
  • #112 Enhancing Monitoring of the service Q by @ A2

...

@lsulak lsulak added the enhancement New feature or request label May 28, 2024
@benedeki
Copy link

I think the link to issue is additional data, not the key information.
I would like it like this:

  • BFS implemented for problem X (#111 by ...)
  • Optimized the backend part Y by Z amount of % on average (#111 by ...)

The #112 stays the same, just wapped order

@benedeki
Copy link

I even think the link to PR is completely surplus, just adds noise. The PR is linked in the issue. (Except warning chapter)

@benedeki
Copy link

Of course nest would be a possibillity to set it via a pattern with placeholders.
× placeholder for issue number

  • placeholder for issue title
    × placeholder for PR number
    × placeholder for contributors
    × placehokder for release note comment one line
    × placeholder fir the whole release note comment
    × placeholder for date of item closing
    × maybe an escape character for placeholders
    × everything else are literals

@miroslavpojer
Copy link
Collaborator

Of course nest would be a possibillity to set it via a pattern with placeholders. × placeholder for issue number

  • placeholder for issue title
    × placeholder for PR number
    × placeholder for contributors
    × placehokder for release note comment one line
    × placeholder fir the whole release note comment
    × placeholder for date of item closing
    × maybe an escape character for placeholders
    × everything else are literals

Do you mean some configurable GH Action input to manage 1st line in example below?

  • '{Issue_number} {Issue_title} by {contributors}' ==> #111 by @ A1
    • BFS implemented for problem X
    • Optimized the backend part Y by Z amount of % on average

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

3 participants