-
Notifications
You must be signed in to change notification settings - Fork 52
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
CLI Reference section #1336
CLI Reference section #1336
Conversation
Specify ids of jobs that you want to run | ||
|
||
#### The Test manifest (`polywrap.test.yaml`) | ||
Basic structure: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have mixed feelings because this is super cool, but in other commands when it comes to manifest we redirect users to documentation - Should that happen here too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that this would be much better suited to live within the docs
repo.
Now that I look at it, https://docs.polywrap.io/quick-start/workflows/running-workflows seems outdated. Maybe rename it to Runnning tests
and update with information found here.
What do you think?
CC @dOrgJelli @krisbitney
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good idea. I think it should also be added to the manifest package readme so we can prepare for the future when our reference documentation is created by copying the readmes into the docs
Should we add an example of how a custom client config file looks like? Usually, I would go to |
That was my thought initially too, but then I linked to a few places with the custom client config. Now that you commented the same thing, I think I could add it where it belongs. Maybe a separate "Custom client config" mini-section, with the various options linking to it. |
Remaining work:
run
command / get feedback from owner ( @Niraj-Kamdar )infra
command / get feedback from ownerdeploy
command / get feedback from ownerexpand onSeems relatively unused and not documented elsewhere - can do as a separate PR if need be.codegen
's-s, --script
optiongenerally expand on theWherever it’s needed, has links to the explanation-c, --client-config
option