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.

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

Support uppercase repository names with cosign. #1294

Merged
merged 3 commits into from
May 3, 2022

Conversation

mattmoor
Copy link
Contributor

@mattmoor mattmoor commented Dec 6, 2021

My previous PR didn't properly handle uppercase usernames (or repository names) when signing container images with cosign.

It seems that the docker buildx --push doesn't like this either, but it's passed the output of the docker/metadata-action which seems to lowercase things.

Fixes: #1293

Signed-off-by: Matt Moore mattmoor@chainguard.dev

thanks to @imjasonh for the suggestion!

Pre-requisites

  • Prior to submitting a new workflow, please apply to join the GitHub Technology Partner Program: partner.github.com/apply.

Tasks

For all workflows, the workflow:

  • Should be contained in a .yml file with the language or platform as its filename, in lower, kebab-cased format (for example, docker-image.yml). Special characters should be removed or replaced with words as appropriate (for example, "dotnet" instead of ".NET").
  • Should use sentence case for the names of workflows and steps (for example, "Run tests").
  • Should be named only by the name of the language or platform (for example, "Go", not "Go CI" or "Go Build").
  • Should include comments in the workflow for any parts that are not obvious or could use clarification.

For CI workflows, the workflow:

  • Should be preserved under the ci directory.
  • Should include a matching ci/properties/*.properties.json file (for example, ci/properties/docker-publish.properties.json).
  • Should run on push to branches: [ $default-branch ] and pull_request to branches: [ $default-branch ].
  • Packaging workflows should run on release with types: [ created ].
  • Publishing workflows should have a filename that is the name of the language or platform, in lower case, followed by "-publish" (for example, docker-publish.yml).

For Code Scanning workflows, the workflow:

  • Should be preserved under the code-scanning directory.
  • Should include a matching code-scanning/properties/*.properties.json file (for example, code-scanning/properties/codeql.properties.json), with properties set as follows:
    • name: Name of the Code Scanning integration.
    • organization: Name of the organization producing the Code Scanning integration.
    • description: Short description of the Code Scanning integration.
    • categories: Array of languages supported by the Code Scanning integration.
    • iconName: Name of the SVG logo representing the Code Scanning integration. This SVG logo must be present in the icons directory.
  • Should run on push to branches: [ $default-branch, $protected-branches ] and pull_request to branches: [ $default-branch ]. We also recommend a schedule trigger of cron: $cron-weekly (for example, codeql.yml).

Some general notes:

  • This workflow must only use actions that are produced by GitHub, in the actions organization, or
  • This workflow must only use actions that are produced by the language or ecosystem that the workflow supports. These actions must be published to the GitHub Marketplace. We require that these actions be referenced using the full 40 character hash of the action's commit instead of a tag. Additionally, workflows must include the following comment at the top of the workflow file:
    # This workflow uses actions that are not certified by GitHub.
    # They are provided by a third-party and are governed by
    # separate terms of service, privacy policy, and support
    # documentation.
    
  • Automation and CI workflows should not send data to any 3rd party service except for the purposes of installing dependencies.
  • Automation and CI workflows cannot be dependent on a paid service or product.

@mattmoor mattmoor requested a review from a team as a code owner December 6, 2021 20:07
@mattmoor
Copy link
Contributor Author

mattmoor commented Dec 6, 2021

cc @bishal-pdMSFT @jhutchings1

Copy link
Contributor

@jhutchings1 jhutchings1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@@ -90,4 +90,4 @@ jobs:
# This step uses the identity token to provision an ephemeral certificate
# against the sigstore community Fulcio instance, and records it to the
# sigstore community Rekor transparency log.
run: cosign sign ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}@${{ steps.build-and-push.outputs.digest }}
run: cosign sign ${{ steps.meta.outputs.tags }}@${{ steps.build-and-push.outputs.digest }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could it be a problem if tags points to a list of tags?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given line 66, I don't think that's possible today, but it could be a problem as folks alter the workflow.

@joshmgross
Copy link
Member

👋 Looks like there are some merge conflicts, possibly from the comment change that went with #1295

@mattmoor
Copy link
Contributor Author

I'll update this shortly

@mattmoor
Copy link
Contributor Author

Ok, this is rebased!

@github-actions
Copy link

This pull request has become stale and will be closed automatically within a period of time. Sorry about that.

@jhutchings1
Copy link
Contributor

@mattmoor Do we still need this change to get merged in? I was surprised to see we never merged it back in December, but I guess holidays got in the way.

@mattmoor
Copy link
Contributor Author

Yeah, I can rebase it, but it had fallen off my radar. thanks for the ping.

My previous PR didn't properly handle uppercase usernames (or repository names) when signing container images with `cosign`.

It seems that the `docker buildx --push` doesn't like this either, but it's passed the output of the `docker/metadata-action` which seems to lowercase things.

Fixes: actions#1293

Signed-off-by: Matt Moore <mattmoor@chainguard.dev>
@winstonsmith132
Copy link

winstonsmith132 commented Mar 16, 2022 via email

@mattmoor
Copy link
Contributor Author

Just noticed this still on my dashboard. I'm happy to rebase, but it'd be great to coordinate with someone that can merge this to avoid spinning my wheels rebasing 🙏

@Phantsure
Copy link
Contributor

Phantsure commented May 2, 2022

@mattmoor should we go ahead with merge, if there are no changes required?

@mattmoor
Copy link
Contributor Author

mattmoor commented May 2, 2022

It's been a while, but I'm pretty sure this is good to go. thanks!

@Phantsure Phantsure merged commit 81bee47 into actions:main May 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docker-publish.yml doesn't work with uppercase usernames/repositories
6 participants