Skip to content

docs(hermetic-build): indicate usage of Docker Buildkit in development guide #3337

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Nov 6, 2024
Merged

docs(hermetic-build): indicate usage of Docker Buildkit in development guide #3337

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
019c369
docs(hermetic-build): indicate usage of Docker Buildkit in developmen…
diegomarquezp Nov 6, 2024
47757bf
Update hermetic_build/DEVELOPMENT.md
diegomarquezp Nov 6, 2024
23693a2
Update DEVELOPMENT.md
diegomarquezp Nov 6, 2024
c8fa84d
Update DEVELOPMENT.md
diegomarquezp Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions hermetic_build/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,11 +160,13 @@ python hermetic_build/library_generation/cli/entry_point.py generate \
1. Run the following command to build the image from source

```shell
docker build \
DOCKER_BUILDKIT=1 docker build \
Copy link
Contributor

@blakeli0 blakeli0 Nov 6, 2024

Choose a reason for hiding this comment

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

Can we mention that DOCKER_BUILDKIT=1 is only needed for local development on CloudTop but not needed in CloudBuild?

Copy link
Contributor Author

@diegomarquezp diegomarquezp Nov 6, 2024

Choose a reason for hiding this comment

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

Added a note below.

-f .cloudbuild/library_generation/library_generation.Dockerfile \
-t local:image-tag \
.
```
Please note that the build only works when using the new
[Docker BuildKit](https://docs.docker.com/build/buildkit/) (enabled through the `DOCKER_BUILDKIT` variable).

2. Set the version of gapic-generator-java

Expand All @@ -177,7 +179,7 @@ python hermetic_build/library_generation/cli/entry_point.py generate \
-q)
```

3. Run the image
4. Run the image

```shell
# Assume you want to generate the library in the current working directory
Expand Down
Loading