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

chore: a better testing your workflows page #137

Open
ChunyiLyu opened this issue Oct 21, 2024 · 1 comment
Open

chore: a better testing your workflows page #137

ChunyiLyu opened this issue Oct 21, 2024 · 1 comment

Comments

@ChunyiLyu
Copy link
Member

ChunyiLyu commented Oct 21, 2024

Context

This is split out from #128.

Improving the Workflows is complex and doesn't have a clear goal

  • Current
    • In this section, we introduce the following concepts today:
      • Pipeline design principles
      • A "test" framework for the promise
  • Problem
    • Lots of boilerplate copy-and-paste. The "test framework" really complicates the entire page (lots to copy and paste, complex scripts we don't explain). The "test" doesn't actually "fail" -- the learner has to check the files themselves, but what are they looking for exactly?
  • Improvement
    • Remove this section entirely? Move the TDD / Design Principles into a section of the Kratix documentation

Note that the test script we introduced in this section is used repeated in the later part of the workshop:

  • Accessing Secrets and storing state
  • Surfacing information via Status
    These sections use the test script to provide fast feedback to users and reply on it for docker build and kind load image. Keep this in mind if we need to shuffle Improving the Workflows around and do not break any of the following sections.
@ChunyiLyu
Copy link
Member Author

cc @catmo-syntasso

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant