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

Replace PipelineResources in examples and documentation #4375

Closed
jerop opened this issue Nov 15, 2021 · 10 comments
Closed

Replace PipelineResources in examples and documentation #4375

jerop opened this issue Nov 15, 2021 · 10 comments
Assignees
@geriom
Labels
lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.

Comments

@jerop
Copy link
Member

jerop commented Nov 15, 2021

Today, some examples and references in documentation use PipelineResources. However, we recently deprecated PipelineResources. For more information about the deprecation, see TEP-0074.

We need to update the examples and references in documentation to use Tasks and other replacement features instead of PipelineResources.

Related Issues:
jerop added a commit to jerop/pipeline that referenced this issue Nov 15, 2021
@jerop
Deprecate PipelineResources
cde10a7 
When we [released Tekton Pipelines Beta in March 2020](https://github.com/tektoncd/pipeline/releases/tag/v0.11.0),
we [decided not to make `PipelineResources` Beta](https://github.com/tektoncd/pipeline/blob/e76d4132ab2ecfbedc45a964f08a01022e2d4c14/docs/resources.md#why-arent-pipelineresources-in-beta).

In [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md),
we decided to officially deprecate `PipelineResources`.

This change announces, documents and warns about the deprecation of
`PipelineResources`.

Follow-on work includes:
- Replace `PipelineResources` from the tutorial - tektoncd#3705
- Replace `PipelineResources` from the examples and documentation - tektoncd#4375
- Continue updating the documentation as work progresses on [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md)
and features replacing `PipelineResources` become available

Closes tektoncd#4344.
@jerop jerop mentioned this issue Nov 15, 2021
Merged
4 tasks
jerop added a commit to jerop/pipeline that referenced this issue Nov 16, 2021
@jerop
Deprecate of PipelineResources
989944b 
When we [released Tekton Pipelines Beta in March 2020](https://github.com/tektoncd/pipeline/releases/tag/v0.11.0),
we [decided not to make `PipelineResources` Beta](https://github.com/tektoncd/pipeline/blob/e76d4132ab2ecfbedc45a964f08a01022e2d4c14/docs/resources.md#why-arent-pipelineresources-in-beta).

In [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md),
we decided to officially deprecate `PipelineResources`.

This change announces, documents and warns about the deprecation of
`PipelineResources`.

Follow-on work includes:
- Replace `PipelineResources` from the tutorial - tektoncd#3705
- Replace `PipelineResources` from the examples and documentation - tektoncd#4375
- Continue updating the documentation as work progresses on [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md)
and features replacing `PipelineResources` become available

Closes tektoncd#4344.
@vdemeester
Copy link
Member

Today, some examples and references in documentation use PipelineResources. However, we recently deprecated PipelineResources. For more information about the deprecation, see TEP-0074.

We need to update the examples and references in documentation to use Tasks and other replacement features instead of PipelineResources.

Related Issues:

Few things.

  1. the TEP is in proposed state. To be fully "deprecated" we need to have a release that state they are deprecated with a timeline ?
  2. The examples are.. not really example as they are used for testing purpose. In that case, as long as the feature is in the code, it needs to be tested. We should probably separate examples (for documentation purposes) from test data in yaml 👼🏼

Other that this +:100: 🎉

jerop added a commit to jerop/pipeline that referenced this issue Nov 16, 2021
@jerop
Deprecate of PipelineResources
2d23874 
When we [released Tekton Pipelines Beta in March 2020](https://github.com/tektoncd/pipeline/releases/tag/v0.11.0),
we [decided not to make `PipelineResources` Beta](https://github.com/tektoncd/pipeline/blob/e76d4132ab2ecfbedc45a964f08a01022e2d4c14/docs/resources.md#why-arent-pipelineresources-in-beta).

In [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md),
we decided to officially deprecate `PipelineResources`.

This change announces, documents and warns about the deprecation of
`PipelineResources`.

Follow-on work includes:
- Replace `PipelineResources` from the tutorial - tektoncd#3705
- Replace `PipelineResources` from the examples and documentation - tektoncd#4375
- Continue updating the documentation as work progresses on [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md)
and features replacing `PipelineResources` become available

Closes tektoncd#4344.
tekton-robot pushed a commit that referenced this issue Nov 16, 2021
@jerop @tekton-robot
Deprecate of PipelineResources
5997596 
When we [released Tekton Pipelines Beta in March 2020](https://github.com/tektoncd/pipeline/releases/tag/v0.11.0),
we [decided not to make `PipelineResources` Beta](https://github.com/tektoncd/pipeline/blob/e76d4132ab2ecfbedc45a964f08a01022e2d4c14/docs/resources.md#why-arent-pipelineresources-in-beta).

In [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md),
we decided to officially deprecate `PipelineResources`.

This change announces, documents and warns about the deprecation of
`PipelineResources`.

Follow-on work includes:
- Replace `PipelineResources` from the tutorial - #3705
- Replace `PipelineResources` from the examples and documentation - #4375
- Continue updating the documentation as work progresses on [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md)
and features replacing `PipelineResources` become available

Closes #4344.
@bobcatfish
Copy link
Collaborator

Just freezing this in advance b/c we need to do this even if it goes stale:

/lifecycle frozen

@tekton-robot tekton-robot added the lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. label Nov 30, 2021
@lbernick lbernick moved this to Todo in Pipelines V1 Jan 11, 2022
@dibyom dibyom moved this from Todo to In Progress in Pipelines V1 Apr 11, 2022
@dibyom
Copy link
Member

dibyom commented Apr 11, 2022

/assign @geriom

@tekton-robot
Copy link
Collaborator

@dibyom: GitHub didn't allow me to assign the following users: geriom.

Note that only tektoncd members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

/assign @geriom

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.

@dibyom dibyom added the priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. label Apr 25, 2022
@geriom
Copy link
Contributor

geriom commented Apr 25, 2022

Commenting so I can be assigned to this issue.

@vdemeester
Copy link
Member

@geriom you should be able to comment ´/assign´ and be directly assigned at the same time I think.
/assign @geriom

@geriom
Copy link
Contributor

geriom commented May 4, 2022

We no longer have the reference to PipelineResources in the tutorial. About the examples, quoting @vdemeester reply:

2. The examples are.. not really example as they are used for testing purpose. In that case, as long as the feature is in the code, it needs to be tested. We should probably separate examples (for documentation purposes) from test data in yaml

@jerop Does that mean we close this issue?

@jerop
Copy link
Member Author

jerop commented May 4, 2022

@geriom sounds good, thank you for working on this issue!

@jerop jerop closed this as completed May 4, 2022
Repository owner moved this from In Progress to Done in Pipelines V1 May 4, 2022
@lbernick
Copy link
Member

lbernick commented May 5, 2022

Maybe we can move examples with pipelineresources out of examples and into test/yamls -- this way they will still be tested but not act as documentation of how to do things

@lbernick
Copy link
Member

lbernick commented Jun 7, 2022

There are still some examples in docs that are using pipelineResources: https://github.com/tektoncd/pipeline/blob/main/docs/tasks.md#code-examples

We might also want to change the examples used for tests that we recommend people look at: https://github.com/tektoncd/pipeline/blob/main/examples/README.md#examples

@lbernick lbernick reopened this Jun 7, 2022
@lbernick lbernick mentioned this issue Jun 14, 2022
Merged
4 tasks
@lbernick lbernick moved this from Done to In Progress in Pipelines V1 Jun 15, 2022
Repository owner moved this from In Progress to Done in Pipelines V1 Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@geriom geriom

Labels
lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
Pipelines V1
Status: Done
Milestone
No milestone
Development

No branches or pull requests
7 participants
@vdemeester @bobcatfish @dibyom @jerop @geriom @lbernick @tekton-robot