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: enable hermetic library generation #1697

Merged
merged 22 commits into from
Jun 30, 2024

Conversation

diegomarquezp
Copy link
Contributor

@diegomarquezp diegomarquezp commented May 28, 2024

This is part of the effort to enable multi-version support in hand-written libraries. More context and details in this doc.

This PR adds two workflows and their scripts:

  • update_generation_config which updates generation_config.yaml (added in this PR) to contain the latest googleapis_committish (source of truth of library generation) as well as other dependencies such as gapic_generator_version. This job runs nightly and creates a PR that modifies the config yaml.
  • hermetic_library_generation which reads generation_config.yaml and pushes a new commit to any PR whose latest commit affects generation_config.yaml (e.g. the nightly PR created by update_generation_config). It essentially translates changes in the config yaml to changes in the source code (of the generated part). This workflow will be a required check.

As an example of how they work in practice:

  1. Once per night, update_generation_config creates a PR that updates generation_config.yaml with the latest dependencies and googleapis committish
  2. hermetic_library_generation is triggered by this PR and generates the corresponding code changes. A new commit with the code changes is added to the PR. This step may occur for any PR affecting generation_config.yaml.

Follow ups

  • Add CLOUD_JAVA_BOT_TOKEN to repository for the hermetic generation workflow to work

@product-auto-label product-auto-label bot added size: l Pull request size is large. api: firestore Issues related to the googleapis/java-firestore API. labels May 28, 2024
@diegomarquezp diegomarquezp marked this pull request as ready for review June 20, 2024 21:28
@diegomarquezp diegomarquezp requested review from a team as code owners June 20, 2024 21:28
Copy link
Contributor

@ehsannas ehsannas left a comment

Choose a reason for hiding this comment

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

Have you run these workflows to test out?

The .sh files look good, although I'm not the best person to review bash files. Given that this is probably done consistently across other repos, would it make sense for someone else from your team to review as well?

@diegomarquezp
Copy link
Contributor Author

Have you run these workflows to test out?

The .sh files look good, although I'm not the best person to review bash files. Given that this is probably done consistently across other repos, would it make sense for someone else from your team to review as well?

@ehsannas thanks for taking a look.

We have tested the scripts in a fork (example PR, example workflow run). These tests are tracked in this internal doc.

We will also go through a review from @blakeli0 (adding now). We need both approvals before we merge this PR.

generation_config.yaml Outdated Show resolved Hide resolved
@diegomarquezp diegomarquezp added the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 28, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 28, 2024
@diegomarquezp diegomarquezp added the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 30, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 30, 2024
@diegomarquezp diegomarquezp added the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 30, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 30, 2024
@diegomarquezp diegomarquezp merged commit 85e66df into googleapis:main Jun 30, 2024
22 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: firestore Issues related to the googleapis/java-firestore API. size: l Pull request size is large.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants