Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

dev: Document example accepted docker image formats for action #1051

Open
corneliusroemer opened this issue Mar 17, 2023 · 2 comments · May be fixed by #1105
Open

dev: Document example accepted docker image formats for action #1051

corneliusroemer opened this issue Mar 17, 2023 · 2 comments · May be fixed by #1105
Labels
enhancement New feature or request

Comments

@corneliusroemer
Copy link
Member

Context
I wanted to test compatibility of ncov build actions with a new docker image (Snakemake 7.24.1).

When triggering through workflow_dispatch one can overwrite the image to be used.

It wasn't clear to me from the description what was accepted here. Would this be ok:

  • nextstrain/base:branch-snakemake-7.24.1
    or would I have to add container registry URL, etc?

It would be great if there was an example tag that was explained or a link to docs where one can see what is accepted here.

The string to be changed is here (and similar for the other actions):

ncov/.github/workflows/rebuild-open.yml

Line 18 in cfa73be

description: 'Specific container image to use for build (will override the default of "nextstrain build")'

Maybe it would be enough to state that the default is nextstrain/base, a classic docker pull image descriptor: https://docs.nextstrain.org/projects/cli/en/stable/commands/build/#development-options
@corneliusroemer corneliusroemer added the enhancement New feature or request label Mar 17, 2023
@tsibley
Copy link
Member

tsibley commented Mar 17, 2023

It's any image descriptor accepted by Docker. This includes:

nextstrain/base
nextstrain/base:branch-snakemake-7.24.1
nextstrain/base@sha256:5efcfcbe3cdcaaed225007b45169ae59f8a154efbde0f720f662c81e1fa39c38
docker.io/nextstrain/base
docker.io/nextstrain/base:branch-snakemake-7.24.1
ghcr.io/another/image

@corneliusroemer
Copy link
Member Author

Thanks @tsibley! This is maybe worth adding to the CLI docs (or not if it's too rarely used/verbose)

@victorlin victorlin linked a pull request May 3, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
No open projects
Nextstrain planning (archived)
Status: New
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document example accepted docker image formats for action nextstrain/ncov
2 participants
@tsibley @corneliusroemer