From ab0d773bad6c9dabe6abcddbc8e2b6770cde941d Mon Sep 17 00:00:00 2001 From: Olivier Gayot Date: Fri, 20 Oct 2023 16:42:12 +0200 Subject: [PATCH] doc: add instructions to build snap with modifs in curtin or probert Signed-off-by: Olivier Gayot --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a0c8f6a1..5d473ddb 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,38 @@ an ISO. Rather than building one from scratch, it's much easier to install your version of subiquity into the daily image. Here's how to do this: -1. Build your change into a snap: +## Commit your changes locally + +If you are only making a change in Subiquity itself, running `git add ` +and then `git commit` should be enough. + +Otherwise, if you made any modification to curtin or probert, you need to ensure that: + +* The modification is committed inside the relevant repository (i.e., `git add` + `git commit`). +* The relevant `source` property in snapcraft.yaml points to the local + repository instead of the upstream repository. +* The relevant `source-commit` property in snapcraft.yaml is updated to reflect + your new revision (one must use the full SHA-1 here). +* The above modifications to snapcraft.yaml are committed. + +Example: +``` +parts: + curtin: + plugin: nil + + # Comment out the original source property, pointing to the upstream repository + #source: https://git.launchpad.net/curtin + # Instead, specify the name of the directory where curtin is checked out + source: curtin + source-type: git + # Update the below so it points to the commit ID within the curtin repository + source-commit: 7c18bf6a24297ed465a341a1f53875b61c878d6b +``` + +## Build and inject your changes into an ISO + +1. Build your changes into a snap: ``` $ snapcraft pack --output subiquity_test.snap