Skip to content

Commit

Permalink
Clarify that the plugin runs pre-command (#11)
Browse files Browse the repository at this point in the history
  • Loading branch information
72636c committed Jul 16, 2020
1 parent 7710877 commit 9d2d964
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @seek-oss/continuous-delivery @seek-oss/standout
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ already exist, and sets the lifecycle policy to the default

```yaml
steps:
- label: ecr
- command: echo 'use your new ECR repo here'
label: ecr
plugins:
- seek-oss/create-ecr#v1.3.0:
name: my-repo
Expand All @@ -23,7 +24,8 @@ A custom lifecycle policy and repository policy may be specified:
```yaml
steps:
- label: ecr
- command: echo 'use your new ECR repo here'
label: ecr
plugins:
- seek-oss/create-ecr#v1.3.0:
lifecycle-policy: path/to/lifecycle-policy.json
Expand All @@ -35,7 +37,8 @@ A custom ECR repository tags file may be specified:
```yaml
steps:
- label: ecr
- command: echo 'use your new ECR repo here'
label: ecr
plugins:
- seek-oss/create-ecr#v1.3.0:
name: my-repo
Expand Down Expand Up @@ -65,6 +68,16 @@ steps:

Path in local repository to the ecr repository tags file.

## Troubleshooting

### 🚨 Error: No command has been provided

This plugin runs on a [`pre-command` hook] to allow it to be chained with other commands and plugins, like the [`docker-ecr-publish` plugin].
You will need to specify a `command` for the step, even if it is just a simple `echo` like in the examples above.

[`docker-ecr-publish` plugin]: https://github.com/seek-oss/docker-ecr-publish-buildkite-plugin
[`pre-command` hook]: https://buildkite.com/docs/agent/v3/hooks#available-hooks

## License

MIT (see [LICENSE](LICENSE))

0 comments on commit 9d2d964

Please sign in to comment.