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

HACKING.md fixes #155

Merged
merged 2 commits into from
Sep 11, 2023
Merged
Changes from all commits
Commits
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
20 changes: 10 additions & 10 deletions HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,18 @@ a new image type, might be:
1. Generate the manifests for the image types that you will be working on.
2. Make changes in an existing image definition or add a new image type.
3. Add appropriate configuration changes:
- If a new image type is added, add it to the [config
map](test/config-map.json) under an appropriate configuration file or write
a new one.
- If an existing image type is being modified, and the change depends on an
image customization, make sure the modification is covered by an existing
[test config](test/configs).
- If a new image type is added, add it to the [config
map](test/config-map.json) under an appropriate configuration file or
write a new one.
- If an existing image type is being modified, and the change depends on an
image customization, make sure the modification is covered by an existing
[test config](test/configs).
4. Generate the relevant manifests without content (`-packages=false
-containers=false -commits=false`).
- If the change depends on a customization, it might be more useful to
generate multiple manifests with different configuration options set and
inspect the differences between them.
5. Inspect the differences between manifests generated in steps 0 and 3.
- If the change depends on a customization, it might be more useful to
generate multiple manifests with different configuration options set and
inspect the differences between them.
5. Inspect the differences between manifests generated in steps 1 and 4.
6. Generate manifest with all content enabled for the relevant image types.
7. Build at least one of the manifests using `osuild` and inspect the output
(boot the image or mount it to look for the desired changes).
Expand Down