Skip to content

Commit

Permalink
chore: Bump version to 1.0.0 and add readme note about secrets access (
Browse files Browse the repository at this point in the history
…#25)

* add warning about secrets access

* bump to 1.0.0

* adjust version in examples
  • Loading branch information
mattsb42-aws authored Feb 11, 2020
1 parent 97b609c commit f202c32
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,12 @@ you need to provide AWS credentials.
We recommend using [aws-actions/configure-aws-credentials]
to configure your credentials for a job.

**NOTE:
GitHub Secrets are not passed to the runner when a workflow is triggered from a forked repository.
This means that you cannot use this action directly in a workflow
that is triggered by pull requests from a fork.
See the [GitHub Secrets docs][github secrets access] for more information.**

The credentials that you provide need to have the following permissions:

- `codebuild:StartBuild`
Expand Down Expand Up @@ -128,7 +134,7 @@ the only CodeBuild Run input you need to provide is the project name.
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: us-east-2
- name: Run CodeBuild
uses: aws-actions/aws-codebuild-run-project@v1
uses: aws-actions/aws-codebuild-run-project@v1.0.0
with:
project-name: CodeBuildProjectName
```
Expand All @@ -150,7 +156,7 @@ this will overwrite them.
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: us-east-2
- name: Run CodeBuild
uses: aws-actions/aws-codebuild-run-project@v1
uses: aws-actions/aws-codebuild-run-project@v1.0.0
with:
project-name: CodeBuildProjectName
buildspec-override: path/to/buildspec.yaml
Expand Down Expand Up @@ -246,4 +252,5 @@ see LICENSE and NOTICE for more information.
[github environment variables]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-environment-variables#default-environment-variables
[github actions job runners]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners#supported-runners-and-hardware-resources
[github workflow syntax]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
[github secrets access]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets#using-encrypted-secrets-in-a-workflow
[aws-actions/configure-aws-credentials]: https://github.com/aws-actions/configure-aws-credentials
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@aws-actions/codebuild-run-build",
"version": "0.1.0",
"version": "1.0.0",
"description": "Execute CodeBuild::startBuild for the current repo.",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit f202c32

Please sign in to comment.