Skip to content

docs: move and rewrite bake reference #1748

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

Jump to bottom
Merged
merged 12 commits into from
May 11, 2023
Merged

docs: move and rewrite bake reference #1748

merged 12 commits into from
May 11, 2023

Conversation

dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Apr 18, 2023

Signed-off-by: David Karlsson david.karlsson@docker.com

  • Move the bake file reference to docker/buildx repo to improve maintainability
  • Rewrite the doc to add more examples

@dvdksn dvdksn force-pushed the docs/bake-reference branch 3 times, most recently from afca1f1 to e197335 Compare April 20, 2023 19:12
@dvdksn
Copy link
Contributor Author

dvdksn commented Apr 20, 2023

@crazy-max I think I managed to migrate the file with history... But I suppose the DCO issue can't really be avoided since many of those commits weren't signed.

@dvdksn
Copy link
Contributor Author

dvdksn commented Apr 20, 2023

Error: Unexpected HTTP response: 429

@crazy-max
Copy link
Member

@crazy-max I think I managed to migrate the file with history... But I suppose the DCO issue can't really be avoided since many of those commits weren't signed.

That's fine for DCO, this is expected.

Error: Unexpected HTTP response: 429

Looks like a network issue, let me restart the build.

crazy-max and others added 11 commits April 24, 2023 12:05
@crazy-max
build: add bake section
043cb3a 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
build: customizing builds section
5d551db 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
build: move bake under the build section
6f0c550 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
build: fix links and formatting
c3fd1e8 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@jedevc @crazy-max
lint: add empty line between console and json code blocks
784dc22 
Signed-off-by: Justin Chadwell <me@jedevc.com>
@crazy-max
build: sort bake fields alphabetically
2dffed3 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
build: added attest field
caf7d2e 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
chore: format with prettier
08d1141 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
fix: changed attest type from Map to List
e5ccb64 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
build: fix JSON formatting for --print
b724a17 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
build: null values support with bake
0589f69 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max crazy-max force-pushed the docs/bake-reference branch from e197335 to e17b8b1 Compare April 24, 2023 10:07
@crazy-max crazy-max requested review from tonistiigi and jedevc April 24, 2023 10:31
tonistiigi
tonistiigi approved these changes Apr 25, 2023
View reviewed changes
docs/bake-reference.md

### `target.contexts`

Additional build contexts.
Copy link
Member

Choose a reason for hiding this comment

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

Follow up: Seems like some things are missing. c3dab80

@dvdksn dvdksn mentioned this pull request Apr 25, 2023
Merged
@dvdksn dvdksn force-pushed the docs/bake-reference branch from e17b8b1 to 0b5dd4f Compare April 25, 2023 18:20
@dvdksn
Copy link
Contributor Author

dvdksn commented Apr 25, 2023 •
edited
Loading

Added a missing section built-in variables and updated links pointing to the old file

@dvdksn dvdksn force-pushed the docs/bake-reference branch from 0b5dd4f to d66e919 Compare April 26, 2023 08:31
@dvdksn
Copy link
Contributor Author

dvdksn commented Apr 26, 2023

Added the missing examples highlighted by @tonistiigi

jedevc
jedevc reviewed Apr 26, 2023
View reviewed changes
@dvdksn dvdksn force-pushed the docs/bake-reference branch from d66e919 to d32efa4 Compare April 26, 2023 12:00
@crazy-max
Copy link
Member

docs-upstream job does not look happy: https://github.com/docker/buildx/actions/runs/4808382935/jobs/8558351051?pr=1748#step:9:4001

#29 [htmltest htmltest 2/2] RUN <<EOF (cat /results...)
#0 0.057 htmltest started at 12:04:18 on _site
#0 0.057 ========================================================================
#0 0.057 engine/reference/commandline/buildx_bake/index.html
#0 0.057   target does not exist --- engine/reference/commandline/buildx_bake/index.html --> /build/bake/reference/
#0 0.057 ========================================================================
#0 0.057 ✘✘✘ failed in 2.800544925s
#0 0.057 1 errors in 2312 documents

I guess we need to fix upstream first?

@jedevc
docs: refactor bake file reference
f8483d7 
Signed-off-by: David Karlsson <david.karlsson@docker.com>
@jedevc jedevc force-pushed the docs/bake-reference branch from d32efa4 to f8483d7 Compare May 11, 2023 11:55
@jedevc jedevc mentioned this pull request May 11, 2023
Merged
@jedevc jedevc merged commit e61a1da into docker:master May 11, 2023
@jedevc jedevc mentioned this pull request May 11, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jedevc jedevc jedevc approved these changes

@tonistiigi tonistiigi tonistiigi approved these changes

@crazy-max crazy-max crazy-max approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dvdksn @crazy-max @tonistiigi @jedevc