Skip to content
This repository was archived by the owner on Aug 4, 2025. It is now read-only.

Commit 095e780

Browse files
committed
chore: Archive this repo
Signed-off-by: Austin Ziegler <[email protected]>
1 parent aa610dc commit 095e780

File tree

1 file changed

+25
-19
lines changed

1 file changed

+25
-19
lines changed

README.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,26 @@
11
# @KineticCafe/docker-image-update-checker
22

3-
This action checks using the DockerHub API if your `image`, which is based on
4-
a documented `base-image`, needs to be rebuilt to use the most recent version of
3+
> This action has been archived. It was originally based on an outdated version
4+
> of [lucacome/docker-image-update-checker][lcdiuc]. That action is now under
5+
> maintenance and should be used instead.
6+
7+
[lcdiuc]: https://github.com/lucacome/docker-image-update-checker
8+
9+
This action checks using the DockerHub API if your `image`, which is based on a
10+
documented `base-image`, needs to be rebuilt to use the most recent version of
511
your `base-image`.
612

713
## Example Usage
814

9-
This example shows a check for `user/app:latest` against an updated `nginx`
10-
base image for the `linux/amd64` architecture.
15+
This example shows a check for `user/app:latest` against an updated `nginx` base
16+
image for the `linux/amd64` architecture.
1117

1218
```yaml
1319
name: Check docker image for update
1420

1521
on:
1622
schedule:
17-
- cron: '0 4 * * *'
23+
- cron: "0 4 * * *"
1824

1925
jobs:
2026
docker-update-check:
@@ -39,16 +45,16 @@ jobs:
3945
4046
### Multiple Platform Support
4147
42-
This example shows a check for `user/app:latest` against an updated `nginx`
43-
base image for both `linux/amd64` and `linux/arm64`. The `needs-update` flag is
44-
set if any one of the platform abase images requires update.
48+
This example shows a check for `user/app:latest` against an updated `nginx` base
49+
image for both `linux/amd64` and `linux/arm64`. The `needs-update` flag is set
50+
if any one of the platform abase images requires update.
4551

4652
```yaml
4753
name: Check docker image for update (multiple platforms)
4854
4955
on:
5056
schedule:
51-
- cron: '0 4 * * *'
57+
- cron: "0 4 * * *"
5258
5359
jobs:
5460
check:
@@ -100,23 +106,23 @@ jobs:
100106
To debug this action, set the `DEBUG` environment variable in the workflow file.
101107
For convenience, `DEBUG` can be set from `${{ secrets.ACTIONS_STEP_DEBUG }}`,
102108
which works even when re-running the action with the `Re-run job` button and
103-
`Enable debug logging`. To read more about debugging actions, see [Debugging
104-
actions][action-debugging].
109+
`Enable debug logging`. To read more about debugging actions, see
110+
[Debugging actions][action-debugging].
105111

106112
## Contributing
107113

108-
@KineticCafe/docker-image-update-checker [welcomes contributions][]. This project, like all
109-
Kinetic Commerce [open source projects][], is under the Kinetic Commerce Open
110-
Source [Code of Conduct][].
114+
@KineticCafe/docker-image-update-checker
115+
[welcomes contributions][welcomes contributions]. This project, like all Kinetic
116+
Commerce [open source projects][open source projects], is under the Kinetic
117+
Commerce Open Source [Code of Conduct][Code of Conduct].
111118

112-
This project is licensed under the MIT license and requires certification via
113-
a Developer Certificate of Origin. See [Licence.md][] for more details.
119+
This project is licensed under the MIT license and requires certification via a
120+
Developer Certificate of Origin. See [Licence.md][Licence.md] for more details.
114121

115122
## Releasing
116123

117-
Releases are prepared with `@vercel/ncc` to produce a single file which must
118-
be committed to `dist/`. Run `pnpm package` or `pnpm all` to produce this
119-
file.
124+
Releases are prepared with `@vercel/ncc` to produce a single file which must be
125+
committed to `dist/`. Run `pnpm package` or `pnpm all` to produce this file.
120126

121127
[welcomes contributions]: https://github.com/KineticCafe/docker-image-update-checker/blob/main/Contributing.md
122128
[code of conduct]: https://github.com/KineticCafe/code-of-conduct

0 commit comments

Comments
 (0)