Skip to content

Update documentation for conversion to bakery.yaml#159

Merged
bschwedler merged 13 commits intomainfrom
single-yaml-documentation
Aug 28, 2025
Merged

Update documentation for conversion to bakery.yaml#159
bschwedler merged 13 commits intomainfrom
single-yaml-documentation

Conversation

@ianpittwood
Copy link
Contributor

No description provided.

@github-actions
Copy link

github-actions bot commented Aug 25, 2025

Test Results

196 tests   196 ✅  1m 25s ⏱️
  1 suites    0 💤
  1 files      0 ❌

Results for commit 3a89913.

♻️ This comment has been updated with latest results.

Copy link
Contributor

@bschwedler bschwedler left a comment

Choose a reason for hiding this comment

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

Thanks for doing this!
I'm curious if you had a co-pilot pirate sidekick! ☠️ 😀

Lots of little comments that might improve some general readability.

Future ideas

I think it would be really useful to be able to define a list of ImageVersionOS and ImageVariant objects at the base level of bakery.yaml and then just reference them later as a string.

We would have to decide on which fields can be used for lookup so it doesn't balloon out of our control, and we could pre-define common ones in our code.

Copy link
Contributor

@bschwedler bschwedler left a comment

Choose a reason for hiding this comment

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

This is looking great.

I may have led you astray with using the <code> tag.

Comment on lines 134 to 135
| `extraRegistries`<br/>*[Registry](#registry) array* | Additional registries to push this image to in addition to the global `registries` in [bakery.yaml](#bakery-configuration). | `[]` | <pre><code class="language-yaml">- host: docker.io<br/> namespace: posit</code></pre> |
| `overrideRegistries`<br/>*[Registry](#registry) array* | If set, overrides the global `registries` in [bakery.yaml](#bakery-configuration) for this image with the given list of registries. | `[]` | <pre><code class="language-yaml">- host: docker.io<br/> namespace: posit</code></pre> |
Copy link
Contributor

Choose a reason for hiding this comment

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

Welp. I the explicit breaks don't seem to be working in the <code> block. 😞

image

@bschwedler bschwedler force-pushed the single-yaml-documentation branch from a28de8a to 3a89913 Compare August 28, 2025 13:46
@bschwedler bschwedler linked an issue Aug 28, 2025 that may be closed by this pull request
@bschwedler bschwedler merged commit 0360c8a into main Aug 28, 2025
3 checks passed
@bschwedler bschwedler deleted the single-yaml-documentation branch August 28, 2025 13:48
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.

Document single YAML configuration for end-users

2 participants