Skip to content
This repository was archived by the owner on Aug 4, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ jobs:

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@4e828ff8d448a8a6e532957b1811f387a63867e8 #v3.29.4
uses: github/codeql-action/init@51f77329afa6477de8c49fc9c7046c15b9a4e79d #v3.29.5
with:
languages: ${{ matrix.language }}
# Ignore dist because it is packaged by ncc and we have no control over that.
Expand All @@ -75,7 +75,7 @@ jobs:
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@4e828ff8d448a8a6e532957b1811f387a63867e8 #v3.29.4
uses: github/codeql-action/autobuild@51f77329afa6477de8c49fc9c7046c15b9a4e79d #v3.29.5

# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
Expand All @@ -88,6 +88,6 @@ jobs:
# ./location_of_script_within_repo/buildscript.sh

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@4e828ff8d448a8a6e532957b1811f387a63867e8 #v3.29.4
uses: github/codeql-action/analyze@51f77329afa6477de8c49fc9c7046c15b9a4e79d #v3.29.5
with:
category: "/language:${{matrix.language}}"
2 changes: 1 addition & 1 deletion .github/workflows/dco.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ jobs:
disable-sudo: true
egress-policy: audit

- uses: KineticCafe/actions-dco@416cafbc9c07f26219d09981d9ac49ce29b5bfea #v1.3.4
- uses: KineticCafe/actions-dco@41ccac559c7150e0e9ffea00785fd173c473e2ee #v1.3.5
2 changes: 1 addition & 1 deletion .github/workflows/zizmor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
- run: zizmor --persona pedantic --format sarif . > results.sarif
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- uses: github/codeql-action/upload-sarif@4e828ff8d448a8a6e532957b1811f387a63867e8 # v3.29.4
- uses: github/codeql-action/upload-sarif@51f77329afa6477de8c49fc9c7046c15b9a4e79d # v3.29.5
with:
sarif_file: results.sarif
category: zizmor
44 changes: 25 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
# @KineticCafe/docker-image-update-checker

This action checks using the DockerHub API if your `image`, which is based on
a documented `base-image`, needs to be rebuilt to use the most recent version of
> This action has been archived. It was originally based on an outdated version
> of [lucacome/docker-image-update-checker][lcdiuc]. That action is now under
> maintenance and should be used instead.

[lcdiuc]: https://github.com/lucacome/docker-image-update-checker

This action checks using the DockerHub API if your `image`, which is based on a
documented `base-image`, needs to be rebuilt to use the most recent version of
your `base-image`.

## Example Usage

This example shows a check for `user/app:latest` against an updated `nginx`
base image for the `linux/amd64` architecture.
This example shows a check for `user/app:latest` against an updated `nginx` base
image for the `linux/amd64` architecture.

```yaml
name: Check docker image for update

on:
schedule:
- cron: '0 4 * * *'
- cron: "0 4 * * *"

jobs:
docker-update-check:
Expand All @@ -39,16 +45,16 @@ jobs:

### Multiple Platform Support

This example shows a check for `user/app:latest` against an updated `nginx`
base image for both `linux/amd64` and `linux/arm64`. The `needs-update` flag is
set if any one of the platform abase images requires update.
This example shows a check for `user/app:latest` against an updated `nginx` base
image for both `linux/amd64` and `linux/arm64`. The `needs-update` flag is set
if any one of the platform abase images requires update.

```yaml
name: Check docker image for update (multiple platforms)

on:
schedule:
- cron: '0 4 * * *'
- cron: "0 4 * * *"

jobs:
check:
Expand Down Expand Up @@ -100,23 +106,23 @@ jobs:
To debug this action, set the `DEBUG` environment variable in the workflow file.
For convenience, `DEBUG` can be set from `${{ secrets.ACTIONS_STEP_DEBUG }}`,
which works even when re-running the action with the `Re-run job` button and
`Enable debug logging`. To read more about debugging actions, see [Debugging
actions][action-debugging].
`Enable debug logging`. To read more about debugging actions, see
[Debugging actions][action-debugging].

## Contributing

@KineticCafe/docker-image-update-checker [welcomes contributions][]. This project, like all
Kinetic Commerce [open source projects][], is under the Kinetic Commerce Open
Source [Code of Conduct][].
@KineticCafe/docker-image-update-checker
[welcomes contributions][welcomes contributions]. This project, like all Kinetic
Commerce [open source projects][open source projects], is under the Kinetic
Commerce Open Source [Code of Conduct][Code of Conduct].

This project is licensed under the MIT license and requires certification via
a Developer Certificate of Origin. See [Licence.md][] for more details.
This project is licensed under the MIT license and requires certification via a
Developer Certificate of Origin. See [Licence.md][Licence.md] for more details.

## Releasing

Releases are prepared with `@vercel/ncc` to produce a single file which must
be committed to `dist/`. Run `pnpm package` or `pnpm all` to produce this
file.
Releases are prepared with `@vercel/ncc` to produce a single file which must be
committed to `dist/`. Run `pnpm package` or `pnpm all` to produce this file.

[welcomes contributions]: https://github.com/KineticCafe/docker-image-update-checker/blob/main/Contributing.md
[code of conduct]: https://github.com/KineticCafe/code-of-conduct
Expand Down
2 changes: 1 addition & 1 deletion biome.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://biomejs.dev/schemas/2.1.2/schema.json",
"$schema": "https://biomejs.dev/schemas/2.1.3/schema.json",
"files": {
"includes": ["**", "!**/coverage/**", "!**/dist/**", "!**/docs/**", "!**/lib/**"]
},
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@
"ky": "^1.8.2"
},
"devDependencies": {
"@biomejs/biome": "2.1.2",
"@biomejs/biome": "2.1.3",
"@types/node": "^20.19.9",
"@vercel/ncc": "^0.38.3",
"typescript": "5.8.3"
"typescript": "5.9.2"
},
"packageManager": "pnpm@10.13.1+sha512.37ebf1a5c7a30d5fabe0c5df44ee8da4c965ca0c5af3dbab28c3a1681b70a256218d05c81c9c0dcf767ef6b8551eb5b960042b9ed4300c59242336377e01cfad"
"packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
}
86 changes: 43 additions & 43 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.