Skip to content

Commit f013bb1

Browse files
authored
perf: use GHCR hosted docker image (#19)
Pull the `phylum-ci` Docker image from the GitHub Container Registry (ghcr.io) instead of Docker Hub. This will allow for unlimited transfers for consumers of the action, regardless of whether they are a public/private repo or using self-hosted runners instead of GitHub-hosted runners. Closes #18
1 parent f48a0fb commit f013bb1

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Here's how to set up `phylum-analyze-pr-action` for local development.
101101
```yaml
102102
# Change this entry in the `action.yml` file to point to your image. Reference:
103103
# https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsimage
104-
image: docker://phylumio/phylum-ci:latest
104+
image: docker://ghcr.io/phylum-dev/phylum-ci:latest
105105
```
106106

107107
4. Commit your changes and push your branch to GitHub:

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The pre-requisites for using this image are:
4848
* Ability to run a [Docker container action][container]
4949
* GitHub-hosted runners must use an Ubuntu runner
5050
* Self-hosted runners must use a Linux operating system and have Docker installed
51-
* Access to the [phylumio/phylum-ci Docker image](https://hub.docker.com/r/phylumio/phylum-ci/tags)
51+
* Access to the `phylum-dev/phylum-ci` Docker image from the [GitHub Container Registry][package]
5252
* A [GitHub token][gh_token] with API access
5353
* Can be the default `GITHUB_TOKEN` provided automatically at the start of each workflow run
5454
* Needs at least write access for `pull-requests` scope - see [documentation][scopes]
@@ -66,6 +66,7 @@ The pre-requisites for using this image are:
6666
[`phylum project create`](https://docs.phylum.io/docs/phylum_project_create) command documentation
6767

6868
[container]: https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action
69+
[package]: https://github.com/phylum-dev/phylum-ci/pkgs/container/phylum-ci
6970
[gh_token]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication
7071
[scopes]: https://docs.github.com/en/developers/apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes
7172
[PAT]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ inputs:
2727
default: phylum-ci
2828
runs:
2929
using: docker
30-
image: docker://phylumio/phylum-ci:latest
30+
image: docker://ghcr.io/phylum-dev/phylum-ci:latest
3131
entrypoint: entrypoint.sh
3232
env:
3333
GITHUB_TOKEN: ${{ inputs.github_token }}

0 commit comments

Comments
 (0)