Update contributing tutorial#1423
Conversation
* Explain the tests and how to use mage to run them. * Add details for other shells * Clarified how to use the local porter build * Link to contributing guide Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
Move the instructions to install mage _after_ you checkout the porter source. Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
The previous example was outdated and triggered errors. The user wasn't asked to replace the porter.yaml generated by porter create with it, but if someone did, we don't want it to fail. Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
|
@iennae Would you like to review this? |
|
This LGTM to me. |
| You can enable tab completion for mage as well, so that you can type | ||
| `mage t[TAB]` and it will complete it with the name of matching targets. | ||
|
|
||
| 1. Install bash-completion if it isn't already installed with either `brew install |
There was a problem hiding this comment.
Would this be applicable to windows folks? I didn't that far into windows development so I'm not sure.
There was a problem hiding this comment.
At the moment the tutorial says
We are improving our support for building Porter on Windows. In a few weeks, we will have it all working on any Windows shell. For now, if you are on Windows, please use Windows Subsystem for Linux (WSL). The rest of this tutorial assumes that you are inside your WSL distribution when installing prerequisites and executing the commands.
So bash completion is something that we can expect from people using WSL.
There was a problem hiding this comment.
I have been in the process of making everything about our dev process work for Windows (without WSL) but it is taking time. So when I can, I document how to do things in PowerShell, and eventually we will get there! 😀
| func TestE2E() error { | ||
| mg.Deps(startLocalDockerRegistry) | ||
| defer stopLocalDockerRegistry() | ||
| mg.Deps(StarlDockerRegistry) |
There was a problem hiding this comment.
curious about the StarlDockerRegistry name from startLocalDockerRegistry .. Should it be StarLDockerRegistry? Just confused here about the naming. I see that the function is defined below and it matches but I wasn't sure if the L stood for local or if this was something else so the camel casing seems weird to me.
There was a problem hiding this comment.
Maybe it was meant to be StartDockerRegistry to match up with the StopDockerRegistry..
There was a problem hiding this comment.
Yeah it was a typo. I'll submit a PR to fix that! 🤦♀️
4 participants
What does this change
https://deploy-preview-1423--porter.netlify.app/contribute/tutorial
https://deploy-preview-1423--porter.netlify.app/quickstart/
What issue does it fix
Fixes #1400
Notes for the reviewer
None
Checklist