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

chore: Include producer example #28

Merged
merged 9 commits into from
May 18, 2024

Conversation

romanini-ciandt
Copy link
Collaborator

@romanini-ciandt romanini-ciandt commented May 13, 2024

The goal of this PR is to introduce an end-to-end test on sharing data with partner automation by adding a usage example. CI will do the auto discover tests (see the run here).

@romanini-ciandt romanini-ciandt changed the title Include producer example chore: Include producer example May 13, 2024
@@ -0,0 +1 @@
��5�iu��?HS�E����B�J�xi%Ϙ
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I added this hard-coded sample DEK in order to avoid adding a null resource with openssl rand command.
(.index at the end is to avoid errors on lint about whitespace at the end of the file - we can't add a whitespace in DEK)

@romanini-ciandt romanini-ciandt marked this pull request as ready for review May 14, 2024 21:11
@romanini-ciandt romanini-ciandt requested review from tdbhacks and a team as code owners May 14, 2024 21:11
Copy link
Member

@tdbhacks tdbhacks left a comment

Choose a reason for hiding this comment

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

This all LGTM, thanks Leo! It does bring up an interesting conversation in my mind though, which is that we should formalize some sort of breaking change policy for the long term, right? It comes to mind as this change adds new input variables, or for other changes we might make in the future.

It's definitely not a concern now and not blocking this change by any means, this repo is still work-in-progress and we state so clearly in the main README, but more like food for thought. I think TF repos generally have a way of announcing something will change, and later change it in the next major version, right?

@romanini-ciandt
Copy link
Collaborator Author

@tdbhacks that is an excellent point!
Usually when the repo is linked with Cloud Foundation Toolkit, it is possible to add a bot to manage the release versions. (See an example in another Google repo)

I'll make a couple tests/researches in order to understand how exactly how the bot works, but what I know is that bot cut releases based on the PR's names. So if the PR has feat/fix/chore in the title, it is considered a minor change, so if the current version is v0.1 it would cut v0.2 when triggered. If it's !feat/!fix (! announces breaking changes) it cuts a major, like from v0.2 to v1.0

@apeabody
Copy link
Contributor

@tdbhacks that is an excellent point! Usually when the repo is linked with Cloud Foundation Toolkit, it is possible to add a bot to manage the release versions. (See an example in another Google repo)

I'll make a couple tests/researches in order to understand how exactly how the bot works, but what I know is that bot cut releases based on the PR's names. So if the PR has feat/fix/chore in the title, it is considered a minor change, so if the current version is v0.1 it would cut v0.2 when triggered. If it's !feat/!fix (! announces breaking changes) it cuts a major, like from v0.2 to v1.0

Hi @romanini-ciandt - It is https://github.com/googleapis/release-please, here is a sample config for a pre-1.0 release: https://github.com/terraform-google-modules/terraform-google-module-template/blob/master/terraform-google-%7B%7Bcookiecutter.module_name%7D%7D/.github/release-please.yml

@romanini-ciandt
Copy link
Collaborator Author

@tdbhacks that is an excellent point! Usually when the repo is linked with Cloud Foundation Toolkit, it is possible to add a bot to manage the release versions. (See an example in another Google repo)
I'll make a couple tests/researches in order to understand how exactly how the bot works, but what I know is that bot cut releases based on the PR's names. So if the PR has feat/fix/chore in the title, it is considered a minor change, so if the current version is v0.1 it would cut v0.2 when triggered. If it's !feat/!fix (! announces breaking changes) it cuts a major, like from v0.2 to v1.0

Hi @romanini-ciandt - It is https://github.com/googleapis/release-please, here is a sample config for a pre-1.0 release: https://github.com/terraform-google-modules/terraform-google-module-template/blob/master/terraform-google-%7B%7Bcookiecutter.module_name%7D%7D/.github/release-please.yml

Great reference @apeabody! Thanks for that! I'll create a PR to introduce the release-please bot into this repo.

@tdbhacks tdbhacks merged commit d7c66d4 into GoogleCloudPlatform:main May 18, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants