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

Enhance release notes automation #3751

Merged
merged 2 commits into from
Jan 20, 2024

Conversation

jackkoenig
Copy link
Contributor

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Internal or build-related (includes code refactoring/cleanup)

Desired Merge Strategy

  • Squash

Release Notes

  • Bump mikepenz/release-changelog-builder-action to v4.1.1
  • It now tabs every line included in the Release Notes section of the PR template

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.5.x, 3.6.x, or 5.x depending on impact, API modification or big change: 6.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

* Bump versions
* It now should tab every line included in the Release Notes section of
  the PR template
@jackkoenig jackkoenig added the Internal Internal change, does not affect users, will be included in release notes label Jan 19, 2024
Comment on lines +59 to 70
},
{
"pattern": "\n\\s*\n",
"flags": "gu",
"target": "\n"
},
{
"pattern": "\n",
"flags": "gu",
"target": "\n "
}
],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can't add comments to the JSON, but the first transformer removes blank lines (necessary to make the bulleted list look correct). The second transformer inserts two spaces after every newline (tabbing everything over).

@jackkoenig jackkoenig merged commit b00b22a into main Jan 20, 2024
18 checks passed
@jackkoenig jackkoenig deleted the jackkoenig/update-release-notes-action branch January 20, 2024 00:06
SpriteOvO pushed a commit to SpriteOvO/chisel that referenced this pull request Jan 20, 2024
* Bump versions
* It now tabs every line included in the Release Notes section of
  the PR template
@jackkoenig jackkoenig added this to the 3.6.x milestone Jan 29, 2024
@mergify mergify bot added the Backported This PR has been backported label Jan 29, 2024
mergify bot pushed a commit that referenced this pull request Jan 29, 2024
* Bump versions
* It now tabs every line included in the Release Notes section of
  the PR template

(cherry picked from commit b00b22a)

# Conflicts:
#	.github/workflows/config/release-notes.json
#	.github/workflows/release-notes.yml
mergify bot pushed a commit that referenced this pull request Jan 29, 2024
* Bump versions
* It now tabs every line included in the Release Notes section of
  the PR template

(cherry picked from commit b00b22a)
jackkoenig added a commit that referenced this pull request Jan 29, 2024
* Bump versions
* It now tabs every line included in the Release Notes section of
  the PR template

(cherry picked from commit b00b22a)

# Conflicts:
#	.github/workflows/config/release-notes.json
#	.github/workflows/release-notes.yml

Co-authored-by: Jack Koenig <koenig@sifive.com>
jackkoenig added a commit that referenced this pull request Jan 29, 2024
* Bump versions
* It now tabs every line included in the Release Notes section of
  the PR template

(cherry picked from commit b00b22a)

Co-authored-by: Jack Koenig <koenig@sifive.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backported This PR has been backported Internal Internal change, does not affect users, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant