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

feat: create release command #1086

Merged
merged 2 commits into from
Mar 26, 2023
Merged

feat: create release command #1086

merged 2 commits into from
Mar 26, 2023

Conversation

pd93
Copy link
Member

@pd93 pd93 commented Mar 26, 2023

Hey @andreynering, I was messing around with the changelog yesterday and I came up with a way that we can automate the release process a bit more. I'm curious on your thoughts as this would mostly effect you.

  • New command in ./cmd/release
  • Can be run with task release -- major|minor|patch|x.x.x
  • Automatically set the version/date in the both changelogs
  • Automatically convert github autolinks (#issue/@user) to FQDNs in the website changelog
    • This means we can keep the short autolinks in the main CHANGELOG.md which is a bit easier to write/manage

I've also reformatted both copies of the changelog slightly.

  • 80 character limit
  • Removed the hard-to-write FQDNs from CHANGELOG.md as they now get converted

Its worth noting that PRs will be linked with /issues in the URL as there is no way to differentiate between issues/PRs using autolinks. However, as PRs are just a special type of issue in GitHub, the link will still work - it just redirects.

@andreynering andreynering added the area: releasing Changes related to the release process. label Mar 26, 2023
@andreynering
Copy link
Member

Looks good. Thanks!

@andreynering andreynering merged commit 4cbdcb2 into master Mar 26, 2023
@andreynering andreynering deleted the release-command branch March 26, 2023 23:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: releasing Changes related to the release process.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants