Skip to content

Commit 5abdc18

Browse files
authored
Update readme & fix arm (#43)
* Update README * Fix typo
1 parent f285a6f commit 5abdc18

File tree

2 files changed

+27
-9
lines changed

2 files changed

+27
-9
lines changed

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,44 +9,62 @@ It contains a [post-command hook](hooks/command), and [tests](tests/command.bats
99
```yml
1010
steps:
1111
- plugins:
12-
- joscha/codecov#v3.1.0: ~
12+
- joscha/codecov#v4.0.1: ~
1313
```
1414
1515
The shell option can be used to forward parameters to the codecov invocation.
16+
1617
```yml
1718
steps:
1819
- plugins:
19-
- joscha/codecov#v3.1.0:
20+
- joscha/codecov#v4.0.1:
2021
args:
21-
- '-v'
22-
- '-F my_flag'
22+
- "-v"
23+
- "-F my_flag"
2324
```
2425
2526
In case you do not want to upload coverage results after a failed `command` step:
2627

2728
```yml
2829
steps:
2930
- plugins:
30-
- joscha/codecov#v3.1.0:
31+
- joscha/codecov#v4.0.1:
3132
skip_on_fail: true
3233
```
3334

3435
By default it will use the bundled PGP key to verify the downloaded binary, but you can override the URL via:
3536

36-
3737
```yml
3838
steps:
3939
- plugins:
40-
- joscha/codecov#v3.1.0:
40+
- joscha/codecov#v4.0.1:
4141
pgp_public_key_url: https://keybase.io/codecovsecurity/pgp_keys.asc
4242
```
4343

44+
Here's a complete example:
45+
46+
```yml
47+
steps:
48+
- plugins:
49+
joscha/codecov#v4.0.1:
50+
skip_on_fail: true
51+
args:
52+
- "--auto-load-params-from=Buildkite"
53+
- "--verbose"
54+
- "upload-process"
55+
- "-F $$BUILDKITE_JOB_ID" # $$ if you have parallel steps (to get the runtime value) otherwise $
56+
- "-r $BUILDKITE_ORGANIZATION_SLUG/$BUILDKITE_PIPELINE_NAME"
57+
- "--git-service=$BUILDKITE_PIPELINE_PROVIDER"
58+
docker_image: "public.ecr.aws/docker/library/buildpack-deps:noble-scm"
59+
cli_version: v0.7.5
60+
```
4461

4562
## Tests
4663

4764
To run the tests of this plugin, run
65+
4866
```sh
49-
docker-compose run --rm tests
67+
docker compose run --rm tests
5068
```
5169

5270
## License

hooks/post-command

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ plugin_read_list_into_result() {
6868

6969
get_codecov_cli() {
7070
case "${OS}" in
71-
alpine|alpine-64|linux|linux-64|macos)
71+
alpine|alpine-arm64|linux|linux-arm64|macos)
7272
# We support these
7373
;;
7474
*)

0 commit comments

Comments
 (0)