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

Docker image: Add source code reference label #4747

Merged

Conversation

mfrister
Copy link
Contributor

What this PR does / why we need it:

Add a opencontainers-standardized label (source) to the Docker image, referencing the ingress-nginx GitHub repository.

This allows tools that automate component updates (in our case Renovate Bot) to automatically find the source repository for the Docker image and extract release notes from there. Renovate Bot can include the relevant release notes automatically in a merge request changing the component version.

In renovatebot/renovate#3753, Renovate added the label for their own Docker image.

This allows tools that automate component updates (in our case Renovate Bot [1])
to automatically find the source repository for the Docker image and extract
release notes from there. Renovate Bot can include the relevant release notes
automatically in a merge request changing the component version.

In [2], Renovate added the label for their own Docker image.

[1] https://github.com/renovatebot/renovate
[2] renovatebot/renovate#3753
@k8s-ci-robot
Copy link
Contributor

Hi @mfrister. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 12, 2019
@cmluciano
Copy link
Contributor

Will defer to @aledbf on this one

@aledbf
Copy link
Member

aledbf commented Nov 15, 2019

@mfrister I don't see any issues adding this label but I think we should add more labels than "source", like

LABEL org.opencontainers.image.title='NGINX Ingress Controller for Kubernetes'
LABEL org.opencontainers.image.documentation='https://kubernetes.github.io/ingress-nginx/'
LABEL org.opencontainers.image.source="https://github.com/kubernetes/ingress-nginx"
LABEL org.opencontainers.image.vendor='The Kubernetes Authors'
LABEL org.opencontainers.image.licenses='Apache-2.0'
LABEL org.opencontainers.image.version='0.26.1'

WDYT?

@mfrister
Copy link
Contributor Author

@aledbf Good idea. Added the labels you suggested, using the TAG available in the Makefile as version label.

@aledbf
Copy link
Member

aledbf commented Nov 18, 2019

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 18, 2019
@codecov-io
Copy link

Codecov Report

Merging #4747 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4747      +/-   ##
==========================================
+ Coverage    58.6%   58.62%   +0.01%     
==========================================
  Files          88       88              
  Lines        6743     6743              
==========================================
+ Hits         3952     3953       +1     
+ Misses       2355     2353       -2     
- Partials      436      437       +1
Impacted Files Coverage Δ
internal/watch/file_watcher.go 84.61% <0%> (+3.84%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d1eea79...dea9c40. Read the comment docs.

@aledbf
Copy link
Member

aledbf commented Nov 19, 2019

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 19, 2019
@aledbf
Copy link
Member

aledbf commented Nov 19, 2019

@mfrister thanks!

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aledbf, mfrister

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 19, 2019
@k8s-ci-robot k8s-ci-robot merged commit 3ffe855 into kubernetes:master Nov 19, 2019
@aledbf aledbf added this to done in 0.27.0 Nov 19, 2019
@mfrister mfrister deleted the image-add-opencontainer-source-label branch November 25, 2019 06:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
No open projects
0.27.0
  
done
Development

Successfully merging this pull request may close these issues.

None yet

5 participants