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 installation name to porter upgrade command in Quickstart #3182

Merged

Conversation

egherrmann
Copy link
Contributor

What does this change

Fixes a typo in one of the Quickstart commands. When following Quickstart for the first time, I received an error in the Upgrade the Installation section:

$ porter upgrade
no bundle specified. Either an installation name, --reference, --file or --cnab-file must be specified or the current directory must contain a porter.yaml file

I believe the intention was for this command to include an installation name. It does succeed when running porter upgrade porter-hello so I've updated the command in the doc.

What issue does it fix

"It's OK to submit a PR directly for problems such as misspellings or other things where the motivation/problem is unambiguous."

Notes for the reviewer

Locally, my porter upgrade porter-hello output is slightly different than what's in the Quickstart, but I don't fully understand those lines and it's probably out of scope for this PR anyway:

--- quickstart 2024-07-11 14:09:23.870653300 -0400
+++ local      2024-07-11 14:09:12.785253900 -0400
@@ -1,3 +1,5 @@
+Just-in-time resolving credentials...
+Just-in-time resolving parameters...
 executing upgrade action from examples/porter-hello (installation: /porter-hello)
 World 2.0
 Hello, porter

Checklist

I'd consider all of these as "not applicable" to a typo-fix:

  • Did you write tests?
  • Did you write documentation?
  • Did you change porter.yaml or a storage document record? Update the corresponding schema file.
  • If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇‍♀️

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature.
kwasniew Mateusz Kwasniewski
When following the Quickstart for the first time, I received an error in the "Upgrade the Installation" section:

```
$ porter upgrade
no bundle specified. Either an installation name, --reference, --file or --cnab-file must be specified or the current directory must contain a porter.yaml file
```

I believe the intention was for this command to include an installation name. It does succeed when running `porter upgrade porter-hello` so I've updated the command

Signed-off-by: Eric Herrmann <26093534+egherrmann@users.noreply.github.com>
@schristoff
Copy link
Member

Thank you so much! Please don't forget to add your name to the contributors file!

egherrmann added a commit to egherrmann/porter that referenced this pull request Jul 11, 2024

Verified

This commit was signed with the committer’s verified signature.
kwasniew Mateusz Kwasniewski
Recommended in [getporter#3182](getporter#3182):

> [Thank you so much! Please don't forget to add your name to the contributors file!][getporter#3182 (comment)]

Signed-off-by: Eric Herrmann <26093534+egherrmann@users.noreply.github.com>
schristoff pushed a commit that referenced this pull request Jul 11, 2024
Recommended in [#3182](#3182):

> [Thank you so much! Please don't forget to add your name to the contributors file!][#3182 (comment)]

Signed-off-by: Eric Herrmann <26093534+egherrmann@users.noreply.github.com>
@schristoff schristoff merged commit a3ee154 into getporter:main Jul 11, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants