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

Add docs and examples for Windows #4138

Merged
merged 2 commits into from
Aug 16, 2021

Conversation

aiden-deloryn
Copy link
Contributor

Changes

A new markdown file has been added to document Windows usage in Tekton.

Some examples have been added to demonstrate how to schedule TaskRuns
and PipelineRuns on a Windows node using node selectors and node
affinity constraints.

/kind documentation

Submitter Checklist

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

  • Docs included if any changes are user facing
  • Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Release notes block below has been filled in or deleted (only if no user facing changes)

Release Notes

NONE

A new markdown file has been added to document Windows usage in Tekton.
@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. labels Aug 5, 2021
@tekton-robot tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 5, 2021
@tekton-robot
Copy link
Collaborator

Hi @aiden-deloryn. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@aiden-deloryn
Copy link
Contributor Author

/assign @dlorenc

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.

/ok-to-test

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 5, 2021
@aiden-deloryn
Copy link
Contributor Author

/retest

@aiden-deloryn
Copy link
Contributor Author

/retest

@dlorenc
Copy link
Contributor

dlorenc commented Aug 5, 2021

The examples actually get run as part of tests, we probably don't have a Windows node in our test clusters to run these on.

@aiden-deloryn
Copy link
Contributor Author

@dlorenc Aren't the examples under taskruns/no-ci/ and pipelineruns/no-ci/ supposed to be skipped for tests?

It seems the failed tests are due to linting / white-space errors:

./examples/v1beta1/pipelineruns/no-ci/windows-node-selectors.yaml
  17:10     error    trailing spaces  (trailing-spaces)

./examples/v1beta1/pipelineruns/no-ci/windows-node-affinity.yaml
  17:10     error    trailing spaces  (trailing-spaces)

./examples/v1beta1/taskruns/no-ci/windows-node-affinity.yaml
  24:9      error    wrong indentation: expected 6 but found 8  (indentation)

Some examples have been added to demonstrate how to schedule TaskRuns
and PipelineRuns on a Windows node using node selectors and node
affinity constraints.
@vdemeester
Copy link
Member

@dlorenc Aren't the examples under taskruns/no-ci/ and pipelineruns/no-ci/ supposed to be skipped for tests?

It seems the failed tests are due to linting / white-space errors:

./examples/v1beta1/pipelineruns/no-ci/windows-node-selectors.yaml
  17:10     error    trailing spaces  (trailing-spaces)

./examples/v1beta1/pipelineruns/no-ci/windows-node-affinity.yaml
  17:10     error    trailing spaces  (trailing-spaces)

./examples/v1beta1/taskruns/no-ci/windows-node-affinity.yaml
  24:9      error    wrong indentation: expected 6 but found 8  (indentation)

They don't run as part of the test (not applied to the cluster, …), but they still get "validated" by the linters 😝

@aiden-deloryn
Copy link
Contributor Author

They don't run as part of the test (not applied to the cluster, …), but they still get "validated" by the linters 😝

That does appear to be the case. Thanks for the confirmation 😄

The tests succeeded after I fixed the linting errors. Please let me know if there is anything else I need to change.

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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 Aug 9, 2021
@bobcatfish
Copy link
Collaborator

I always love more docs :D

/lgtm

image

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 16, 2021
@tekton-robot tekton-robot merged commit 5062ac4 into tektoncd:main Aug 16, 2021
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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants