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

TEP-0114: Custom Tasks Beta - Documentation #5158

Closed
Tracked by #4313
, #5753
...
jerop opened this issue Jul 18, 2022 · 4 comments
Closed
Tracked by #4313
, #5753
...

TEP-0114: Custom Tasks Beta - Documentation #5158

jerop opened this issue Jul 18, 2022 · 4 comments
Assignees
@XinruZhang
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@jerop
Copy link
Member

jerop commented Jul 18, 2022 •
edited
Loading

In TEP-0114: Custom Tasks Beta, we proposed migrating Custom Tasks and Runs to beta.

Ahead of the promotion, we agreed to expand the documentation for Custom Tasks and Runs. This issue tracks the documentation work.
@jerop jerop mentioned this issue Jul 18, 2022
Closed
7 tasks
@jerop jerop added the kind/feature Categorizes issue or PR as related to a new feature. label Jul 18, 2022
@lbernick lbernick moved this to Todo in Pipelines V1 Jul 26, 2022
@vsinghai
Copy link
Contributor

vsinghai commented Aug 8, 2022

/assign

vsinghai added a commit to vsinghai/pipeline that referenced this issue Aug 29, 2022
@vsinghai
TEP-0114: Updating runs.md Documentation
339a976 
Prior to this commit, the previous iteration
of the runs.md doc had some fields missing from
the API and the level of detail and clarification.

In this commit, we aim to clarify the API and update
it to make sure it is clear, upto date, and has useful
examples.

Fixes issue [tektoncd#5158](tektoncd#5158)

/cc @jerop
/kind documentation
@vsinghai vsinghai mentioned this issue Aug 29, 2022
Closed
7 tasks
@XinruZhang
Copy link
Member

/assign

@XinruZhang
Copy link
Member

XinruZhang commented Oct 21, 2022 •
edited
Loading

Thanks for the well-structrued todos @jerop! As we discussed offline, I'm extending the TODOs listed in #5158 (comment). I don't have the edit permission on the comment so I'm just copying over and add a bit of details.

  • Migration guide for v1alpha1.Run --> v1beta1.CustomRun
    • Prepare a migration doc, refer to the migration doc in the runs.md and pipelines.md
    • Remove illustration about how to use alpha run
    • Add illustration about how to use beta customrun
  • UX improvement
    • Add a table of known Custom Tasks to runs.md for visibility - can get started with the list of eight in TEP-0114

@XinruZhang XinruZhang mentioned this issue Oct 24, 2022
Merged
7 tasks
This was referenced Nov 14, 2022
Closed
Closed
@jerop jerop mentioned this issue Dec 10, 2022
Merged
7 tasks
@jerop
Copy link
Member Author

jerop commented Dec 12, 2022

Completed in #5677 and #5850

@jerop jerop closed this as completed Dec 12, 2022
Repository owner moved this from Todo to Done in Pipelines V1 Dec 12, 2022
Repository owner moved this from Todo to Done in Tekton Community Roadmap Dec 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@XinruZhang XinruZhang

Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
Pipelines V1
Status: Done
Tekton Community Roadmap
Status: Done
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jerop @vsinghai @XinruZhang