Skip to content

Commit d501d64

Browse files
committed
chore: Adjust README
1 parent b4579c2 commit d501d64

File tree

1 file changed

+32
-43
lines changed

1 file changed

+32
-43
lines changed

README.md

Lines changed: 32 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Actions
22

3-
This repository contains various reusable actions which encapsulate series of
4-
commands to run a particular step in a workflow.
3+
This repository contains various reusable actions which encapsulate series of commands to run a
4+
particular step in a workflow.
55

66
## Definitions
77

@@ -22,35 +22,31 @@ commands to run a particular step in a workflow.
2222
Manifest: [build-product-image/action.yml][build-product-image]
2323

2424
> [!NOTE]
25-
> The build step is not concerned with registries, ports, paths to repositories,
26-
> but still requires a name. If the name does not contain a registry,
27-
> `hub.docker.com` (?) is implied. Therefore, `localhost` will be used as the
28-
> registry so as to avoid accidental interactions with an unintended registry.
25+
> The build step is not concerned with registries, ports, paths to repositories, but still requires
26+
> a name. If the name does not contain a registry, `hub.docker.com` (?) is implied. Therefore,
27+
> `localhost` will be used as the registry so as to avoid accidental interactions with an unintended
28+
> registry.
2929
>
30-
> Ideally, bake should be refactored to use `localhost` as the registry for the
31-
> previously mentioned reason (whether or not that is behind some option).
30+
> Ideally, bake should be refactored to use `localhost` as the registry for the previously mentioned
31+
> reason (whether or not that is behind some option).
3232
33-
This action builds a *single* container image using `bake`. It does the
34-
following work:
33+
This action builds a *single* container image using `bake`. It does the following work:
3534

3635
1. Free disk space to avoid running out of disk space during larger builds.
3736
2. Build the image using `bake` which internally uses `docker buildx`.
38-
3. Temporarily retag the image to use `localhost` instead of
39-
`docker.stackable.tech/stackable`.
37+
3. Temporarily retag the image to use `localhost` instead of `docker.stackable.tech/stackable`.
4038
4. Produce output values to be used in later steps.
4139

42-
This action is considered to be the **single** source of truth regarding image
43-
index tag and image manifest tag. All subsequent tasks must use these values to
44-
ensure consistency.
40+
This action is considered to be the **single** source of truth regarding image index tag and image
41+
manifest tag. All subsequent tasks must use these values to ensure consistency.
4542

4643
Currently, bake provides the following ouput in the `bake-target-tags` file:
4744

4845
```plain
4946
docker.stackable.tech/stackable/kafka:3.4.1-stackable0.0.0-dev-amd64
5047
```
5148

52-
Until bake supports the ability to specify the registry, this action will retag
53-
the image as:
49+
Until bake supports the ability to specify the registry, this action will retag the image as:
5450

5551
```plain
5652
localhost/kafka:3.4.1-stackable0.0.0-dev-amd64
@@ -59,8 +55,7 @@ localhost/kafka:3.4.1-stackable0.0.0-dev-amd64
5955
### Inputs and Outputs
6056

6157
> [!TIP]
62-
> For descriptions of the inputs and outputs, see the [build-product-image]
63-
> workflow.
58+
> For descriptions of the inputs and outputs, see the complete [build-product-image] action.
6459
6560
#### Inputs
6661

@@ -80,29 +75,27 @@ localhost/kafka:3.4.1-stackable0.0.0-dev-amd64
8075

8176
Manifest: [publish-image/action.yml][publish-image]
8277

83-
This action signs and publishes a *single* container image to the given
84-
registry. It does the following work:
78+
This action signs and publishes a *single* container image to the given registry. It does the
79+
following work:
8580

86-
1. Tag the `source-image-uri` with the specified `image-registry-uti`,
87-
`image-repository`, and `image-repository`.
81+
1. Tag the `source-image-uri` with the specified `image-registry-uti`, `image-repository`, and
82+
`image-repository`.
8883
2. Push the container image to the specified registry.
89-
3. Sign the container image (which pushes the signature to the specified
90-
registry).
84+
3. Sign the container image (which pushes the signature to the specified registry).
9185
4. Generate an SBOM via a syft scan.
92-
5. Attest an image with the SBOM as a predicate (which pushes the attestation
93-
to the specified registry).
86+
5. Attest an image with the SBOM as a predicate (which pushes the attestation to the specified
87+
registry).
9488

9589
### Inputs and Outputs
9690

9791
> [!TIP]
98-
> For descriptions of the inputs and outputs, see the [publish-image] workflow.
92+
> For descriptions of the inputs and outputs, see the complete [publish-image] action.
9993
10094
<!-- markdownlint-disable-next-line MD028 -->
10195
> [!IMPORTANT]
102-
> For multi-arch images, the `image-manifest-tag` should have the `-$ARCH`
103-
> suffix, as the tag without it should be reserved for the image index manifest
104-
> which will refer to container images for each architecture we will push images
105-
> for.
96+
> For multi-arch images, the `image-manifest-tag` should have the `-$ARCH` suffix, as the tag
97+
> without it should be reserved for the image index manifest which will refer to container images
98+
> for each architecture we will push images for.
10699
107100
#### Inputs
108101

@@ -123,20 +116,16 @@ None
123116

124117
Manifest: [publish-index-manifest/action.yml][publish-index-manifest]
125118

126-
This action creates an image index manifest, publishes it, and signs it. It does
127-
the following work:
119+
This action creates an image index manifest, publishes it, and signs it. It does the following work:
128120

129-
1. Create an image index manifest and link to each architecture in
130-
`image-architectures`.
121+
1. Create an image index manifest and link to each architecture in `image-architectures`.
131122
2. Push the image index manifest.
132-
3. Sign the image index manifest (which pushes the signature to the specified
133-
registry).
123+
3. Sign the image index manifest (which pushes the signature to the specified registry).
134124

135125
### Inputs and Outputs
136126

137127
> [!TIP]
138-
> For descriptions of the inputs and outputs, see the [publish-index-manifest]
139-
> workflow.
128+
> For descriptions of the inputs and outputs, see the complete [publish-index-manifest] action.
140129
141130
#### Inputs
142131

@@ -157,8 +146,8 @@ None
157146

158147
Manifest: [shard/action.yml][shard]
159148

160-
This action produces a list of versions for a product. This is to be used as a
161-
matrix dimension to parallelize builds. It does the following work:
149+
This action produces a list of versions for a product. This is to be used as a matrix dimension to
150+
parallelize builds. It does the following work:
162151

163152
1. Reads the `conf.py`, filtering versions for the product
164153
2. Write the JSON array of version to `$GITHUB_OUTPUT` for use in a matrix.
@@ -190,7 +179,7 @@ jobs:
190179
### Inputs and Outputs
191180

192181
> [!TIP]
193-
> For descriptions of the inputs and outputs, see the [shard] workflow.
182+
> For descriptions of the inputs and outputs, see the complete [shard] action.
194183
195184
#### Inputs
196185

0 commit comments

Comments
 (0)