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

Move Step when expressions documentation from StepActions to Tasks documetnation. #8672

Conversation

twoGiants
Copy link
Contributor

@twoGiants twoGiants commented Mar 25, 2025

Changes

Previously the docs for using when expressions to guard steps was under the StepActions docs. It was moved to the Tasks docs under "Tasks > Configuring a Task > Defining Steps > Guarding Step execution using when expressions".

Closes #8623.

See screenshots in the comment below.

Submitter Checklist

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

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • Has Tests included if any functionality added or changed
  • pre-commit Passed
  • 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). See some examples of good release notes.
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. release-note-none Denotes a PR that doesnt merit a release note. labels Mar 25, 2025
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 25, 2025
@twoGiants
Copy link
Contributor Author

@lcarva you can take a look. I will test the docs locally before setting it ready for review though.

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Mar 25, 2025
@twoGiants twoGiants force-pushed the issue-8623-move-steps-when-expressions-docs branch from 2d4ad03 to c62d579 Compare March 25, 2025 19:07
Copy link
Contributor

@lcarva lcarva left a comment

Choose a reason for hiding this comment

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

🎉

Previously the docs for using when expressions to guard steps was under
the StepActions docs. It was moved to the Tasks docs under
"Tasks > Configuring a Task > Defining Steps > Guarding Step execution
using when expressions".

Issue tektoncd#8623

Signed-off-by: Stanislav Jakuschevskij <[email protected]>
@twoGiants twoGiants force-pushed the issue-8623-move-steps-when-expressions-docs branch from c62d579 to 27ffd7d Compare March 28, 2025 13:21
@twoGiants
Copy link
Contributor Author

twoGiants commented Mar 28, 2025

This is how it will look. PR is now done @lcarva. Thank you for the review 👍.

Screenshot from 2025-03-28 14-20-25
Screenshot from 2025-03-28 14-19-58
Screenshot from 2025-03-28 14-20-15

@twoGiants twoGiants marked this pull request as ready for review March 28, 2025 13:25
@tekton-robot tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 28, 2025
@tekton-robot tekton-robot requested a review from pritidesai March 28, 2025 13:25
@lcarva
Copy link
Contributor

lcarva commented Mar 28, 2025

/lgtm

Thanks, @twoGiants!

@tekton-robot
Copy link
Collaborator

@lcarva: changing LGTM is restricted to collaborators

In response to this:

/lgtm

Thanks, @twoGiants!

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.

@twoGiants
Copy link
Contributor Author

/lgtm

Thanks, @twoGiants!

You're welcome :) But it looks like only the collaborators can set the "lgtm" here @afrittoli @vdemeester.

@waveywaves
Copy link
Member

/lgtm

+1 for reorganizing docs

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 28, 2025
@twoGiants
Copy link
Contributor Author

/lgtm

+1 for reorganizing docs

Thanks @waveywaves ! Now just one "approve" is missing and it will be merged.

Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

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

/meow

@tekton-robot
Copy link
Collaborator

@vdemeester: cat image

In response to this:

/meow

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
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lcarva, vdemeester

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 Apr 1, 2025
@tekton-robot tekton-robot merged commit ff7443c into tektoncd:main Apr 1, 2025
18 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Tekton Community Roadmap Apr 1, 2025
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. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Move step.when docs out of stepactions
5 participants