Skip to content

docs: update chisel how-to guides #679

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 5 commits into from
Aug 29, 2024
Merged

docs: update chisel how-to guides #679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b3ac126
docs: update chisel howto guides
Aug 26, 2024
55557a8
apply review changes
Aug 28, 2024
e931038
Merge branch 'main' into ROCKS-1433/update-chisel-howto-guides
Aug 28, 2024
054b9c7
Merge branch 'main' into ROCKS-1433/update-chisel-howto-guides
Aug 29, 2024
ad17153
Merge branch 'main' into ROCKS-1433/update-chisel-howto-guides
tigarmo Aug 29, 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
12 changes: 10 additions & 2 deletions docs/how-to/chisel/publish-slice.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,18 @@ It is as simple as proposing your changes into the upstream

cp <path/to/your/slice/definitions/file> slices
git add slices/
git commit -m "feat: add new slice definitions for 'name_of_the_package'"
git commit -m "feat(22.04): add new slice definitions for 'package_name'"
git push origin create-openssl-bins-slice

Create a pull request and wait for it to be merged.
4. Create integration tests to test your changes.
If applicable, add integration tests for your changes in
``tests/spread/integration/<package_name>``. Those tests are composed of a
``task.yaml`` file (plus a few accompanying test scripts if needed) that
contains instructions on how to cut the slices you created or changed and test
their functionalities. You can find examples on how to write such tests in the
child folders of ``tests/spread/tests``.

5. Create a pull request and wait for it to be merged.

And that's it! Your custom Chisel release and new slice definitions are now
available in Chisel, and anyone can use them. **Congrats**! And thank you for
Expand Down
6 changes: 3 additions & 3 deletions docs/how-to/code/install-slice/task.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ execute: |
git clone -b ubuntu-22.04 https://github.com/canonical/chisel-releases/
# [docs:clone-chisel-releases-end]

sudo snap install chisel --channel=latest/candidate

# [docs:slice-exists]
grep -q "bins" chisel-releases/slices/openssl.yaml && echo "My slice exists"
chisel find --release=./chisel-releases/ openssl_bins
# [docs:slice-exists-end]

sudo snap install chisel --channel=latest/candidate

# [docs:cut]
# Testing with Chisel directly:
mkdir -p my-custom-openssl-fs
Expand Down