docs(contributing): update Gitpod guidance #10380
Conversation
ghost
requested a review
from 
|
Title does not follow the guidelines of Conventional Commits. Please adjust title before merge. |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
ghost
changed the title
| we recommend using [Gitpod](http://gitpod.io) - | ||
| a service that allows you to spin up an in-browser | ||
| Visual Studio Code-compatible editor, | ||
| with everything set up and ready to go for CDK development. | ||
| Best of all, the project is already built. |
There was a problem hiding this comment.
I would move this below (where it discusses the build currently).
| This will start a new Gitpod workspace. | ||
| You can now work on any package that you want to modify, |
There was a problem hiding this comment.
While I agree the current wording is incorrect, we need more subtlety here, as it's possible in some cases that the workspace will not be pre-built, and the user will have to wait for the build to complete. See my blog article on this for details: https://www.endoflineblog.com/cdk-tips-02-how-to-contribute-to-the-cdk#gitpod-environment .
Maybe we can use a similar wording to that article (feel free to improve it of course 🙂):
(In rare cases, you might create a workspace just after a commit to the main branch has been pushed; since a full build of the project takes around 45 minutes, there is a short window of time after a push where the pre-build is not ready. In that case, you might have to wait a bit for the build to finish.)
| We don't recommend doing a full build on GitPod; it takes over | ||
| an hour. Also, it will fail unless you include `--skip-prereqs` | ||
| on the `yarn build` command (because Docker doesn't work in a | ||
| Gitpod workspace). Instead, just discard your Gitpod workspace | ||
| and create a new one. You will get the latest source files and | ||
| bulid artifacts. |
There was a problem hiding this comment.
How do you feel about moving this paragraph to the ### Main build scripts section below? Not sure it fits here.
| You can build and test only the module you're working on and its | ||
| consumers using `scripts/builddown`. |
There was a problem hiding this comment.
How about instead of this, we link to the #partial-build section below?
|
This was subsumed by #13525. |
Update Gitpod guidance in contribution guidelines.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license