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 Automation #15

Merged
merged 3 commits into from
Mar 15, 2022
Merged

Release Automation #15

merged 3 commits into from
Mar 15, 2022

Conversation

jpogran
Copy link
Contributor

@jpogran jpogran commented Mar 14, 2022

This adds a GitHub Action that packages up the syntax files for consumption in other products. The action is triggered by a git tag matching the version strategy we use and automatically generates a changelog inside the release based on all pull requests since last. A release document was added explaining the process.

A release would be downloaded using a URL like: https://github.com/hashicorp/syntax/releases/download/v0.2.3/terraform.tmGrammar.json

An example release looks like this:

image

This adds a GitHub Action that packages up the syntax files for consumption in other products. The action is triggered by a git tag matching the version strategy we use and automatically generates a changelog inside the release based on all pull requests since last.
@jpogran jpogran self-assigned this Mar 14, 2022
@jpogran jpogran added this to the 0.1.0 milestone Mar 14, 2022
@jpogran jpogran marked this pull request as ready for review March 14, 2022 16:30
@jpogran jpogran added the build label Mar 14, 2022
@jpogran jpogran requested a review from a team March 14, 2022 17:55
Copy link
Contributor

@glennsarti glennsarti left a comment

Choose a reason for hiding this comment

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

SHIPZ IT

Copy link
Member

@radeksimko radeksimko left a comment

Choose a reason for hiding this comment

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

Just minor notes in-line, nothing blocking.

Personally I think human-maintained changelog > generated changelog, but then to be fair generated changelog > no changelog 😄 so LGTM from that perspective.

RELEASE.md Outdated

## Increment Version

1. Ensure that CHANGELOG.MD has all changes since last release. Add if any are missing.
Copy link
Member

Choose a reason for hiding this comment

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

Given that you decided to generate the changelog via gh, is this still accurate?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This generates the text put into the GitHub Release. It does not update the CHANGELOG.md, yet. The generated text is not a 1:1 match to how we format our changelog, so I did not attempt to do that yet.

Co-authored-by: Radek Simko <radek.simko@gmail.com>
Copy link
Member

@dbanck dbanck left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Co-authored-by: Daniel Banck <dbanck@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants