Adding documentation to help develop ALI lambdas and some useful scripts #6256
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
facebook-github-bot
added
the
CLA Signed
zxiiro
reviewed
Feb 4, 2025
terraform-aws-github-runner/modules/runners/lambdas/runners/README.md
Outdated
Show resolved
Hide resolved
terraform-aws-github-runner/modules/runners/lambdas/runners/README.md
Outdated
Show resolved
Hide resolved
terraform-aws-github-runner/modules/runners/lambdas/runners/README.md
Outdated
Show resolved
Hide resolved
terraform-aws-github-runner/modules/runners/lambdas/runners/README.md
Outdated
Show resolved
Hide resolved
|
Looks good to me. I suggested fixes for a few typos. Thanks for documenting this! |
…ADME.md Co-authored-by: Thanh Ha <thanh.ha@linuxfoundation.org>
…ADME.md Co-authored-by: Thanh Ha <thanh.ha@linuxfoundation.org>
…ADME.md Co-authored-by: Thanh Ha <thanh.ha@linuxfoundation.org>
…ADME.md Co-authored-by: Thanh Ha <thanh.ha@linuxfoundation.org>
zxiiro
approved these changes
Feb 4, 2025
ZainRizvi
approved these changes
Feb 4, 2025
|
|
||
| ### Expectations | ||
|
|
||
| It is **required** to submit code: |
There was a problem hiding this comment.
Suggested change
| It is **required** to submit code: | |
| **Requirements** when submitting code: |
Comment on lines
+39
to
+41
| * No linting warnings are being thrown; | ||
| * The code must be fully compilable to javascript; | ||
| * Code formatting are according to current standards (prettier); |
There was a problem hiding this comment.
Doesn't CI fail if these requirements aren't met?
Can we instead change these three lines to: "All CI checks pass"
|
|
||
| It is *advisable* to strive to when submitting code: | ||
|
|
||
| * Improve as much as possible unit test code coverage; |
There was a problem hiding this comment.
Suggested change
| * Improve as much as possible unit test code coverage; | |
| * Improve unit test code coverage as much as possible; |
|
|
||
| ### Makefile helpers | ||
|
|
||
| Those are primarly used for CI, but, it might be useful to understand, there are 3 commands: |
There was a problem hiding this comment.
Suggested change
| Those are primarly used for CI, but, it might be useful to understand, there are 3 commands: | |
| Those are primarly used for CI, but, it might be useful to understand. There are 3 commands: |
|
|
||
| **WARNING: In practice, even with canary, we only have production environment, be aware that you can break things when running tests!** | ||
|
|
||
| So, it is not really recommended to do so, unless troubleshooting something that you have limited understanding and can't replicate locally. |
There was a problem hiding this comment.
Suggested change
| So, it is not really recommended to do so, unless troubleshooting something that you have limited understanding and can't replicate locally. | |
| So, it is not really recommended to do so, unless troubleshooting something that you have a limited understanding of and can't replicate locally. |
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.
Added a README.md on
terraform-aws-github-runner/modules/runners/lambdas/runners/README.mdwith instruction on how to develop and troubleshoot lambdas development.