{"id":22117724,"url":"https://github.com/kineticcafe/docker-image-update-checker","last_synced_at":"2025-03-24T06:14:23.313Z","repository":{"id":250649796,"uuid":"835048796","full_name":"KineticCafe/docker-image-update-checker","owner":"KineticCafe","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-10T14:30:38.000Z","size":1148,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-10T15:37:03.274Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KineticCafe.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog.md","contributing":"Contributing.md","funding":".github/FUNDING.yml","license":"licenses/MIT.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"halostatue","buy_me_a_coffee":"halostatue","ko_fi":"halostatue"}},"created_at":"2024-07-29T04:00:37.000Z","updated_at":"2025-03-10T14:30:42.000Z","dependencies_parsed_at":"2024-11-11T09:27:52.633Z","dependency_job_id":"32be2b0d-9bdb-4bc8-9d7e-144e341bdc25","html_url":"https://github.com/KineticCafe/docker-image-update-checker","commit_stats":null,"previous_names":["kineticcafe/docker-image-update-checker"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KineticCafe%2Fdocker-image-update-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KineticCafe%2Fdocker-image-update-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KineticCafe%2Fdocker-image-update-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KineticCafe%2Fdocker-image-update-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KineticCafe","download_url":"https://codeload.github.com/KineticCafe/docker-image-update-checker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245217936,"owners_count":20579300,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-01T13:38:55.173Z","updated_at":"2025-03-24T06:14:23.294Z","avatar_url":"https://github.com/KineticCafe.png","language":"TypeScript","funding_links":["https://github.com/sponsors/halostatue","https://buymeacoffee.com/halostatue","https://ko-fi.com/halostatue"],"categories":[],"sub_categories":[],"readme":"# @KineticCafe/docker-image-update-checker\n\nThis action checks using the DockerHub API if your `image`, which is based on\na documented `base-image`, needs to be rebuilt to use the most recent version of\nyour `base-image`.\n\n## Example Usage\n\nThis example shows a check for `user/app:latest` against an updated `nginx`\nbase image for the `linux/amd64` architecture.\n\n```yaml\nname: Check docker image for update\n\non:\n  schedule:\n    - cron: '0 4 * * *'\n\njobs:\n  docker-update-check:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: KineticCafe/docker-image-update-checker@v1\n        id: check\n        with:\n          base-image: nginx:1.21.0\n          image: user/app:latest\n\n      - uses: actions/checkout@v4\n        if: steps.check.outputs.needs-update == 'true'\n\n      - uses: docker/build-push-action@5.1.0\n        with:\n          context: .\n          push: true\n          tags: user/app:latest\n        if: steps.check.outputs.needs-update == 'true'\n```\n\n### Multiple Platform Support\n\nThis example shows a check for `user/app:latest` against an updated `nginx`\nbase image for both `linux/amd64` and `linux/arm64`. The `needs-update` flag is\nset if any one of the platform abase images requires update.\n\n```yaml\nname: Check docker image for update (multiple platforms)\n\non:\n  schedule:\n    - cron: '0 4 * * *'\n\njobs:\n  check:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: KineticCafe/docker-image-update-checker@v1\n        id: check\n        with:\n          base-image: nginx:1.21.0\n          image: user/app:latest\n          platform: linux/amd64,linux/arm64\n\n  build:\n    runs-on: ubuntu-latest\n    needs: check\n    if: needs.check.outputs.needs-updating == 'true'\n\n    steps:\n      - uses: actions/checkout@v4\n\n      - uses: docker/setup-qemu-action@v3.0.0\n      - uses: docker/setup-buildx-action@v3.1.0\n\n      - uses: docker/build-push-action@5.1.0\n        with:\n          context: .\n          push: true\n          tags: user/app:latest\n          platforms: |\n            linux/amd64\n            linux/arm64\n```\n\n## Inputs\n\n- `image`: The target docker image for comparison.\n- `base-image`: The base docker image to compare against.\n- `platforms`: Image platforms to check. Defaults to `linux/amd64`. If _any_ of\n  the platforms are not present in either `image` or `base-image`, this action\n  will exit with an error.\n\n## Outputs\n\n- `needs-output`: Returns `true` if the `image` needs to be updated because the\n  `base-imge` has received an update.\n\n## Debugging\n\nTo debug this action, set the `DEBUG` environment variable in the workflow file.\nFor convenience, `DEBUG` can be set from `${{ secrets.ACTIONS_STEP_DEBUG }}`,\nwhich works even when re-running the action with the `Re-run job` button and\n`Enable debug logging`. To read more about debugging actions, see [Debugging\nactions][action-debugging].\n\n## Contributing\n\n@KineticCafe/docker-image-update-checker [welcomes contributions][]. This project, like all\nKinetic Commerce [open source projects][], is under the Kinetic Commerce Open\nSource [Code of Conduct][].\n\nThis project is licensed under the MIT license and requires certification via\na Developer Certificate of Origin. See [Licence.md][] for more details.\n\n## Releasing\n\nReleases are prepared with `@vercel/ncc` to produce a single file which must\nbe committed to `dist/`. Run `pnpm package` or `pnpm all` to produce this\nfile.\n\n[welcomes contributions]: https://github.com/KineticCafe/docker-image-update-checker/blob/main/Contributing.md\n[code of conduct]: https://github.com/KineticCafe/code-of-conduct\n[open source projects]: https://github.com/KineticCafe\n[licence.md]: https://github.com/KineticCafe/docker-image-update-checker/blob/main/Licence.md\n[dco]: https://developercertificate.org\n[action-debugging]: https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkineticcafe%2Fdocker-image-update-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkineticcafe%2Fdocker-image-update-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkineticcafe%2Fdocker-image-update-checker/lists"}