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-0075] Add variable usage and links to examples in docs #5222

Merged
merged 1 commit into from
Aug 8, 2022
Merged

[TEP-0075] Add variable usage and links to examples in docs #5222

merged 1 commit into from
Aug 8, 2022

Conversation

chuangw6
Copy link
Member

Changes

  • Added instructions on how object variables can be used on Pipeline
    and Task level.
  • Added links to example yaml files in docs/tasks.md.

/kind misc

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

Update docs

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/misc Categorizes issue or PR as a miscellaneuous one. labels Jul 26, 2022
@tekton-robot tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 26, 2022
@chuangw6
Copy link
Member Author

/test check-pr-has-kind-label

@tekton-robot
Copy link
Collaborator

@chuangw6: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

  • /test pull-tekton-pipeline-alpha-integration-tests
  • /test pull-tekton-pipeline-build-tests
  • /test pull-tekton-pipeline-integration-tests
  • /test tekton-pipeline-unit-tests

The following commands are available to trigger optional jobs:

  • /test pull-tekton-pipeline-go-coverage

Use /test all to run all jobs.

In response to this:

/test check-pr-has-kind-label

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.

@ywluogg
Copy link
Contributor

ywluogg commented Jul 26, 2022

/assign ywluogg

@chuangw6 chuangw6 changed the title [TEP-0075] Add variable usage and links to examples in docs. [TEP-0075] Add variable usage and links to examples in docs Jul 26, 2022
lbernick
lbernick reviewed Jul 29, 2022
View reviewed changes
docs/tasks.md Outdated
@@ -555,13 +553,6 @@ metadata:
name: task-with-parameters
spec:
params:
- name: gitrepo
Copy link
Member

Choose a reason for hiding this comment

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

Curious what's the reason to remove this? I think it's useful to have example usage in the docs as well as in the examples folder

Copy link
Member Author

Choose a reason for hiding this comment

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

sg! added them back. Thanks

@tekton-robot tekton-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 29, 2022
@chuangw6
Copy link
Member Author

/test pull-tekton-pipeline-integration-tests

@chuangw6
[TEP-0075] Add variable usage and links to examples in docs.
574c280 
- Added instructions on how object variables can be used on Pipeline
and Task level.
- Added links to example yaml files in `docs/tasks.md`.
@tekton-robot tekton-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 3, 2022
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick

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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 3, 2022
@abayer
Copy link
Contributor

abayer commented Aug 4, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 4, 2022
@chuangw6
Copy link
Member Author

chuangw6 commented Aug 4, 2022

/test pull-tekton-pipeline-integration-tests

@chuangw6
Copy link
Member Author

chuangw6 commented Aug 5, 2022

/retest

@chuangw6 chuangw6 mentioned this pull request Aug 5, 2022
Closed
7 tasks
@chuangw6
Copy link
Member Author

chuangw6 commented Aug 5, 2022

/test pull-tekton-pipeline-alpha-integration-tests

@abayer
Copy link
Contributor

abayer commented Aug 8, 2022

/retest

@tekton-robot tekton-robot merged commit 000c485 into tektoncd:main Aug 8, 2022
@Yongxuanzhang Yongxuanzhang mentioned this pull request Sep 27, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lbernick lbernick lbernick approved these changes

@abayer abayer Awaiting requested review from abayer

@dlorenc dlorenc Awaiting requested review from dlorenc

Assignees

@abayer abayer

@ywluogg ywluogg

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/misc Categorizes issue or PR as a miscellaneuous one. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@chuangw6 @tekton-robot @ywluogg @abayer @lbernick