Skip to content

Commit 7e47ecb

Browse files
committed
Improve taggers and manifests docs
1 parent 7a5244b commit 7e47ecb

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/maintaining/tagging.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Tagging and manifest creation
1+
# Tags and manifests
22

33
The main purpose of the source code in [the `tagging` folder](https://github.com/jupyter/docker-stacks/tree/main/tagging) is to
44
properly write tags file, build history line and manifest for a single-platform image,
@@ -58,33 +58,35 @@ All the taggers follow `TaggerInterface`:
5858

5959
So, the `tagger(container)` gets a docker container as an input and returns a tag.
6060

61-
`commit_sha_tagger` example:
61+
For example:
6262

6363
```{literalinclude} ../../tagging/taggers/sha.py
6464
:language: py
6565
:start-at: def
6666
```
6767

6868
- `taggers/` subdirectory contains all taggers.
69-
- `apps/write_tags_file.py`, `apps/apply_tags.py`, and `apps/merge_tags.py` are Python executable used to write tags for an image, apply tags from a file, and create multi-arch images.
69+
- `apps/write_tags_file.py`, `apps/apply_tags.py`, and `apps/merge_tags.py` are Python executables used to write tags for an image, apply tags from a file, and create multi-arch images.
7070

7171
### Manifest
7272

7373
All manifest functions except `build_info_manifest` follow `ManifestInterface`
74-
and `manifest(container)` method returns a piece of the build manifest.
74+
and `manifest(container)` method returns a piece of the manifest.
7575

7676
```{literalinclude} ../../tagging/manifests/manifest_interface.py
7777
:language: py
7878
:start-at: ManifestInterface
7979
```
8080

81-
`apt_packages_manifest` example:
81+
For example:
8282

8383
```{literalinclude} ../../tagging/manifests/apt_packages.py
8484
:language: py
8585
:start-at: def
8686
```
8787

88+
where:
89+
8890
- `quoted_output(container, cmd)` simply runs the command inside a container using `DockerRunner.exec_cmd` and wraps it to triple quotes to create a valid markdown piece.
8991
It also adds the command which was run to the markdown piece.
9092
- `manifests/` subdirectory contains all the manifests.

0 commit comments

Comments
 (0)