pipeline icon indicating copy to clipboard operation
pipeline copied to clipboard

[WIP] Add docs for removing images

Open JeromeJu opened this issue 2 years ago • 8 comments

Changes

This commit adds the docs for removing images.

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • [ ] Has Docs included if any changes are user facing
  • [ ] Has Tests included if any functionality added or changed
  • [ ] Follows the commit message standard
  • [ ] Meets the Tekton contributor standards (including functionality, content, code)
  • [ ] Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • [ ] Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • [ ] Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

JeromeJu avatar Jan 23 '23 16:01 JeromeJu

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: To complete the pull request process, please assign jerop after the PR has been reviewed. You can assign the PR to them by writing /assign @jerop in a comment when ready.

The full list of commands accepted by this bot can be found 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

tekton-robot avatar Jan 23 '23 16:01 tekton-robot

@JeromeJu: The label(s) kind/docs cannot be applied, because the repository doesn't have them.

In response to this:

/kind docs

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.

tekton-robot avatar Jan 23 '23 16:01 tekton-robot

/kind documentation

JeromeJu avatar Jan 23 '23 16:01 JeromeJu

cc @QuanZhang-William I have been aware that we are extracting some git-init related images for catalog. PTAL if there are anything to be added or this could be useful at all?

JeromeJu avatar Jan 23 '23 16:01 JeromeJu

I'm not sure we need docs specifically for removing images. For example, instructions on release notes are already covered by our process docs, and the integration test instructions are more relevant for pipelineresources than for removing images. We also don't really have a good way of knowing what catalog Tasks use these images. It might be more helpful to add a readme to the cmd/ folder explaining what each of the images are used for.

lbernick avatar Jan 23 '23 16:01 lbernick

  • Remove the dependencies from publish.yaml

(This bit is important though - we should note that somewhere)

dibyom avatar Jan 23 '23 17:01 dibyom

cc @QuanZhang-William I have been aware that we are extracting some git-init related images for catalog. PTAL if there are anything to be added or this could be useful at all?

Thanks @JeromeJu for the heads up. There are 2 separate things:

  1. Remove the images and all the dependencies from pipeline project
  2. Host the image source code in separate repos (extract) if necessary

Seems like the instructions here are for 1). For 2) We can add an example when git-init image is extracted to verified catalog repo.

So /lgtm

QuanZhang-William avatar Jan 23 '23 17:01 QuanZhang-William

The following Tekton test failed:

Test name Commit Details Required Rerun command
check-pr-has-kind-label bacc8d55190315fd99f5a06ede490b596b912926 link true /test check-pr-has-kind-label

tekton-robot avatar Feb 03 '23 15:02 tekton-robot

Closing old PRs - it seems that were discussions about whether we need the docs at all, if you change your mind about needing the docs, feel free to reopen this PR

jerop avatar Apr 20 '23 13:04 jerop