-
Notifications
You must be signed in to change notification settings - Fork 76
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
Utility scripts #391
Utility scripts #391
Conversation
Signed-off-by: Giuseppe Maxia <[email protected]>
Signed-off-by: Giuseppe Maxia <[email protected]>
Signed-off-by: Giuseppe Maxia <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What are the main differences from the way we generate changelog in Terraform?
BTW, there are typos in the PR description: "terraform-prov0wider-vcd. To re-assemple"
The main differences:
This PR aims at having both CHANGELOGs follow the same pattern. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Only one thing: I see in the generated CHANGELOG extra new lines in between the groups of changes. Is the idea to reconcile them manually before the release? This could be human-error-prone.
We can make a "perfect and final" assembly tool, but it would require using something better than a shell script. The goal here is to make a good-enough draft that we can adapt manually before releasing. We have been doing the same in terraform-provider-vcd. |
Signed-off-by: Giuseppe Maxia <[email protected]>
Signed-off-by: Giuseppe Maxia <[email protected]>
Signed-off-by: Giuseppe Maxia <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! A brief test worked.
Add .changes folder
Add a folder
.changes' and
scripts/make-changelog.shto avoid
CHANGELOGconfilcts . This is similar to the organization of terraform-provider-vcd. To re-assemble the CHANGELOG, use
./scripts-make-changelog.sh VERSION`.To show how the CHANGELOG would be organized, I added the items for v2.12.0 and v2.12.1.
Allow staticcheck to run in GitHub Actions
The test with
staticcheck
had stopped working when we transitioned from Travis to GitHub Actions. Changing the trigger variable fixed it. I also added a skip comment for a function that is used on demand for debugging.