Skip to content

Commit

Permalink
Improve tagging docs: do not show useless imports
Browse files Browse the repository at this point in the history
  • Loading branch information
mathbunnyru committed Feb 21, 2025
1 parent c5da3ed commit 066fd4a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/maintaining/tagging.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ All the taggers are inherited from `TaggerInterface`:

```{literalinclude} ../../tagging/taggers/tagger_interface.py
:language: py
:lines: 3-
:start-at: class TaggerInterface
```

So, the `tag_value(container)` method gets a docker container as an input and returns a tag.
Expand All @@ -61,7 +61,7 @@ So, the `tag_value(container)` method gets a docker container as an input and re

```{literalinclude} ../../tagging/taggers/sha.py
:language: py
:lines: 3-
:start-at: class SHATagger
```

- `taggers/` subdirectory contains all the taggers.
Expand All @@ -76,7 +76,7 @@ All the other manifest classes are inherited from `ManifestInterface`:

```{literalinclude} ../../tagging/manifests/manifest_interface.py
:language: py
:lines: 3-
:start-at: class ManifestInterface
```

- The `markdown_piece(container)` method returns a piece of markdown file to be used as a part of the build manifest.
Expand All @@ -85,7 +85,7 @@ All the other manifest classes are inherited from `ManifestInterface`:

```{literalinclude} ../../tagging/manifests/apt_packages.py
:language: py
:lines: 3-
:start-at: class AptPackagesManifest
```

- `quoted_output(container, cmd)` simply runs the command inside a container using `DockerRunner.run_simple_command` and wraps it to triple quotes to create a valid markdown piece.
Expand Down

0 comments on commit 066fd4a

Please sign in to comment.