Skip to content

Commit c1aeb26

Browse files
committed
Add Download and Veryfying binaries section to README
1 parent 4de5628 commit c1aeb26

File tree

1 file changed

+59
-5
lines changed

1 file changed

+59
-5
lines changed

README.md

Lines changed: 59 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,67 @@ For installation instructions, check out our docs on [Configuring Test Coverage]
1313

1414
To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing/).
1515

16-
## Releasing a new version
16+
# Versioning
17+
The test reporter's current version is documented in [VERSIONING/VERSION](https://github.com/codeclimate/test-reporter/blob/master/VERSIONING/VERSION), following the [Semantic Versioning](https://semver.org/) convention.
1718

18-
Test reporter's new versions are released automatically when pushing to branches that match `vx.x.x`. The test reporter's current version is documented in [VERSIONING/VERSION](https://github.com/codeclimate/test-reporter/blob/master/VERSIONING/VERSION), following the [Semantic Versioning](https://semver.org/) convention.
19+
# Binaries
1920

20-
There are two script helpers for creating a new release:
21-
- [release-scripts/prep-release](https://github.com/codeclimate/test-reporter/blob/master/release-scripts/prep-release) which will create a new pull request, patching the current version. If you need to create a new MINOR or MAJOR version creating a manual pull request is the way to go.
22-
- [release-scripts/release](https://github.com/codeclimate/test-reporter/blob/master/release-scripts/release) This script will create a new branch named `vx.x.x` that matches the version indicated in [VERSIONING/VERSION](https://github.com/codeclimate/test-reporter/blob/master/VERSIONING/VERSION), which should trigger the CI for creating a new release.
21+
## Download
22+
The test reporter is distributed as a pre-built binary named cc-test-reporter. You can fetch the pre-built binary from the following URLs:
23+
24+
### Linux
25+
- [codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64](https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64)
26+
- [codeclimate.com/downloads/test-reporter/test-reporter-${VERSION}-linux-amd64](https://codeclimate.com/downloads/test-reporter/test-reporter-${VERSION}-linux-amd64)
27+
28+
29+
### Linux netcgo (recommended if you're using a VPN)
30+
- [codeclimate.com/downloads/test-reporter/test-reporter-latest-netcgo-linux-amd64](https://codeclimate.com/downloads/test-reporter/test-reporter-latest-netcgo-linux-amd64)
31+
- [codeclimate.com/downloads/test-reporter/test-reporter-${VERSION}-netcgo-linux-amd64](https://codeclimate.com/downloads/test-reporter/test-reporter-${VERSION}-netcgo-linux-amd64)
32+
33+
### OS X
34+
- [codeclimate.com/downloads/test-reporter/test-reporter-latest-darwin-amd64](https://codeclimate.com/downloads/test-reporter/test-reporter-latest-darwin-amd64)
35+
- [codeclimate.com/downloads/test-reporter/test-reporter-${VERSION}-darwin-amd64](https://codeclimate.com/downloads/test-reporter/test-reporter-${VERSION}-darwin-amd64)
36+
37+
38+
#### e.g
39+
>```console
40+
>$ curl -O https://codeclimate.com/downloads/test-reporter/test-reporter-0.10.1-darwin-amd64
41+
>```
42+
43+
## Verifying binaries
44+
45+
Along with the binaries you can download a file with a SHA 256 checksum for the given version from the link shown below, or you can attach it to your clipboard from the [docs page](https://docs.codeclimate.com/docs/configuring-test-coverage#locations-of-pre-built-binaries).
46+
47+
- [codeclimate.com/downloads/test-reporter/test-reporter-${VERSION}-darwin-amd64.sha256](https://codeclimate.com/downloads/test-reporter/test-reporter-${VERSION}-darwin-amd64.sha256)
48+
49+
To download the file containing the checksum using `curl`:
50+
#### e.g
51+
>```console
52+
>$ curl -O https://codeclimate.com/downloads/test-reporter/test-reporter-0.10.1-darwin-amd64.sha256
53+
>```
54+
55+
To check that a downloaded file matches the checksum, run it through `shasum` with a command such as:
56+
57+
```console
58+
$ grep test-reporter-${VERSION}-darwin-amd64 test-reporter-${VERSION}-darwin-amd64.sha256 | shasum -a 256 -c -
59+
```
60+
61+
The GPG detached signature of SHA checksums can be download analogously from the following url:
62+
63+
- [codeclimate.com/downloads/test-reporter/test-reporter-${VERSION}-darwin-amd64.sha256.sig](https://codeclimate.com/downloads/test-reporter/test-reporter-${VERSION}-darwin-amd64.sha256.sig)
64+
65+
You can use it with `gpg` to verify the integrity of your downloaded checksum. You will first need to import
66+
the GPG publick key. To import the key:
67+
68+
```console
69+
$ gpg --keyserver keys.openpgp.org --recv-keys 9BD9E2DD46DA965A537E5B0A5CBF320243B6FD85
70+
```
71+
72+
Then use the following command to verify the file's signature.
73+
74+
```console
75+
$ gpg --verify test-reporter-${VERSION}-darwin-amd64.sha256.sig test-reporter-${VERSION}-darwin-amd64.sha256
76+
```
2377

2478
## Copyright
2579

0 commit comments

Comments
 (0)