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

Utility scripts #391

Merged
merged 6 commits into from
Aug 3, 2021
Merged

Utility scripts #391

merged 6 commits into from
Aug 3, 2021

Conversation

dataclouder
Copy link
Contributor

@dataclouder dataclouder commented Jul 5, 2021

Add .changes folder

Add a folder .changes' and scripts/make-changelog.shto avoidCHANGELOGconfilcts . 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.

Giuseppe Maxia added 2 commits July 5, 2021 20:23
@dataclouder dataclouder marked this pull request as ready for review July 5, 2021 18:33
@dataclouder dataclouder mentioned this pull request Jul 5, 2021
Copy link
Collaborator

@lvirbalas lvirbalas left a 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"

@dataclouder
Copy link
Contributor Author

dataclouder commented Jul 8, 2021

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:

  • We use a single block CHANGELOG.md that causes conflicts at almost every merge
  • In terraform-provider-vcd we use headers for all items in the CHANGELOG, while in go-vcloud-director we only use "breaking changes" and improvements.

This PR aims at having both CHANGELOGs follow the same pattern.
If you run ./scripts-make-changelog.sh v2.12.0 you'd see how the new format applies to the latest release. Note: the outcome has extra spacing to allow for better editing of the final CHANGELOG.

Copy link
Collaborator

@lvirbalas lvirbalas left a 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.

@dataclouder
Copy link
Contributor Author

dataclouder commented Jul 8, 2021

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.

Giuseppe Maxia added 3 commits August 3, 2021 14:21
Signed-off-by: Giuseppe Maxia <[email protected]>
Signed-off-by: Giuseppe Maxia <[email protected]>
Copy link
Collaborator

@Didainius Didainius left a 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.

@dataclouder dataclouder merged commit 20d75cd into vmware:master Aug 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants