fix: name all args for add_services instruction in quickstart #316
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying with
|
| Latest commit: |
4816b4c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4667905c.kurtosis-docs.pages.dev |
| Branch Preview URL: | https://derek-quickstart-name-all-ar.kurtosis-docs.pages.dev |
h4ck3rk3y
approved these changes
Mar 23, 2023
leoporoli
pushed a commit
that referenced
this pull request
Mar 23, 2023
## Description: Since Starlark requires named args to come after positional args, or have all args be named, the change made [here](https://github.com/kurtosis-tech/kurtosis/pull/299/files#diff-db23839e9fa71374d53983730e318028367dff34e8c817cd1e8acfec09624fe8L200) meant that the starlark package would fail to run. This PR names _all_ the args in the `add_service` and `add_services` instruction in our quickstart code snippets to ensure it runs smoothly. This change also ensures that the code snippet follows the same syntax structure as what our reference docs say [here](https://docs.kurtosis.com/reference/starlark-instructions#add_service) ## Is this change user facing? YES <!-- If yes, please add the "user facing" label to the PR --> <!-- If yes, don't forget to include docs changes where relevant --> ## References (if applicable): <!-- Add relevant Github Issues, Discord threads, or other helpful information. --> #299 --------- Co-authored-by: Derek Lee <derek@Dereks-MacBook-Pro.local>
gbouv
pushed a commit
that referenced
this pull request
Mar 27, 2023
🤖 I have created a release *beep* *boop* --- ## [0.70.1](0.70.0...0.70.1) (2023-03-27) ### Features * Add context `rm` command ([#275](#275)) ([c20ca12](c20ca12)) * Add context `switch` CLI command ([#317](#317)) ([ebab7eb](ebab7eb)) * add kurtosis engine logs command that dumps logs for all engines in target dir ([#313](#313)) ([cbb588c](cbb588c)) * result of add service contains a `name` property ([#314](#314)) ([af8ca5f](af8ca5f)) * Tunnel remote APIC port to local machine using Kurtosis Portal ([#295](#295)) ([4c3ba69](4c3ba69)) ### Bug Fixes * add example historical version ([#150](#150)) ([1548489](1548489)) * be clear about the engine that is being started ([#282](#282)) ([5bc1b79](5bc1b79)) * Fix starlark value reference bug ([#322](#322)) ([63f6626](63f6626)) * name all args for add_services instruction in quickstart ([#316](#316)) ([d413826](d413826)) * reformat build prereqs in readme ([#290](#290)) ([c286151](c286151)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: kurtosisbot <kurtosisbot@users.noreply.github.com>
leoporoli
pushed a commit
that referenced
this pull request
Mar 27, 2023
🤖 I have created a release *beep* *boop* --- ## [0.70.1](0.70.0...0.70.1) (2023-03-27) ### Features * Add context `rm` command ([#275](#275)) ([c20ca12](c20ca12)) * Add context `switch` CLI command ([#317](#317)) ([ebab7eb](ebab7eb)) * add kurtosis engine logs command that dumps logs for all engines in target dir ([#313](#313)) ([cbb588c](cbb588c)) * result of add service contains a `name` property ([#314](#314)) ([af8ca5f](af8ca5f)) * Tunnel remote APIC port to local machine using Kurtosis Portal ([#295](#295)) ([4c3ba69](4c3ba69)) ### Bug Fixes * add example historical version ([#150](#150)) ([1548489](1548489)) * be clear about the engine that is being started ([#282](#282)) ([5bc1b79](5bc1b79)) * Fix starlark value reference bug ([#322](#322)) ([63f6626](63f6626)) * name all args for add_services instruction in quickstart ([#316](#316)) ([d413826](d413826)) * reformat build prereqs in readme ([#290](#290)) ([c286151](c286151)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: kurtosisbot <kurtosisbot@users.noreply.github.com>
leeederek
added a commit
that referenced
this pull request
Mar 28, 2023
Fixes a typo introduced in #316
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Since Starlark requires named args to come after positional args, or have all args be named, the change made here meant that the starlark package would fail to run.
This PR names all the args in the
add_serviceandadd_servicesinstruction in our quickstart code snippets to ensure it runs smoothly. This change also ensures that the code snippet follows the same syntax structure as what our reference docs say hereIs this change user facing?
YES
References (if applicable):
#299