-
Notifications
You must be signed in to change notification settings - Fork 17
Add initial project files #1
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
Conversation
Config
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This Config file is only used for internal Amazon packages, so we shouldn't have it here
| - uses: actions/checkout@v3 | ||
|
|
||
| - name: Configure AWS credentials | ||
| uses: aws-actions/configure-aws-credentials@v2 | ||
| with: | ||
| role-to-assume: arn:aws:iam::123456789012:role/GitHubActionRole | ||
| - name: Deploy Lambda function | ||
| uses: aws-actions/amazon-lambda-deploy@v1 | ||
| with: | ||
| function-name: my-lambda-function | ||
| code-artifacts-dir: ./dist |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we have a build step in the example so that a user is not required to build and commit the build artifacts for things to work?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was thinking about that, but realized that different runtimes have different build steps.
| code-artifacts-dir: ./dist | ||
| ``` | ||
|
|
||
| To use OIDC authentication, you must configure a trust policy in AWS IAM that allows GitHub Actions to assume an IAM role. Here's an example trust policy: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there some docs of the configure-aws-credentials that we could link to in our README when it comes to setting up credentials?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about the quick start for OIDC? https://github.com/aws-actions/configure-aws-credentials/tree/main?tab=readme-ov-file#quick-start-oidc-recommended
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
node_module directory should be excluded via .gitignore
node_modules/.bin/acorn
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like .gitignore was excluded from this change. We should be ignoring directories like node_modules and coverage.
e.g. https://github.com/aws-actions/amazon-ecs-deploy-task-definition/blob/master/.gitignore
3baf077 to
79929a4
Compare
chloe1818
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated initial files
|
Looks like these checks require the repo to be public in order to run properly. Besides this the changes look good. |
Issue #, if available:
N/A
Description of changes:
These are the initial project files being added to the repository.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.