Skip to content

Updating README with an example of doing an inline definition for buildspec-override. #128

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 16, 2023
+37 −2
Merged

Updating README with an example of doing an inline definition for buildspec-override. #128

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e91f255
adding in an example on how to do an inline buildspec example
alexjyong Mar 4, 2023
74c4adb
indentation was a little off. fixing it.
alexjyong Mar 4, 2023
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 37 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,42 @@ The only required input is `project-name`.
The location (in this repository) of the [buildspec file][codebuild buildspec]
that CodeBuild requires.
By default, the action uses the buildspec file location
that you configured in the CodeBuild project.
that you configured in the CodeBuild project.

Alternatively, you can pass in an inline buildspec definition like so:

```
- name: Run CodeBuild
uses: aws-actions/aws-codebuild-run-build@v1
with:
project-name: my-codebuild-job
disable-source-override: true
buildspec-override: |
version: 0.2
phases:
install:
runtime-versions:
nodejs: 16
commands:
- npm install -g typescript
- npm install
pre_build:
commands:
- echo Installing source NPM dependencies...
build:
commands:
- echo Build started on `date`
- tsc
- npm prune --production
post_build:
commands:
- echo Build completed on `date`
artifacts:
type: zip
files:
- package.json
- package-lock.json
```
1. **compute-type-override** (optional) :
The name of a compute type for this build that overrides the one specified
in the build project.
Expand Down Expand Up @@ -201,7 +236,7 @@ this will overwrite them.
uses: aws-actions/aws-codebuild-run-build@v1
with:
project-name: CodeBuildProjectName
buildspec-override: path/to/buildspec.yaml
buildspec-override: path/to/buildspec.yaml or inline buildspec definition
compute-type-override: compute-type
environment-type-override: environment-type
image-override: ecr-image-uri
Expand Down