Skip to content

Improve markdown for crane code snippets #2091

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve markdown for crane code snippets #2091

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions cmd/crane/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,29 @@ A collection of useful things you can do with `crane` is [here](recipes.md).
1. Get the [latest release](https://github.com/google/go-containerregistry/releases/latest) version.

```sh
$ VERSION=$(curl -s "https://api.github.com/repos/google/go-containerregistry/releases/latest" | jq -r '.tag_name')
VERSION=$(curl -s "https://api.github.com/repos/google/go-containerregistry/releases/latest" | jq -r '.tag_name')
```

or set a specific version:

```sh
$ VERSION=vX.Y.Z # Version number with a leading v
VERSION=vX.Y.Z # Version number with a leading v
```

1. Download the release.

```sh
$ OS=Linux # or Darwin, Windows
$ ARCH=x86_64 # or arm64, x86_64, armv6, i386, s390x
$ curl -sL "https://github.com/google/go-containerregistry/releases/download/${VERSION}/go-containerregistry_${OS}_${ARCH}.tar.gz" > go-containerregistry.tar.gz
OS=Linux # or Darwin, Windows
ARCH=x86_64 # or arm64, x86_64, armv6, i386, s390x
curl -sL "https://github.com/google/go-containerregistry/releases/download/${VERSION}/go-containerregistry_${OS}_${ARCH}.tar.gz" > go-containerregistry.tar.gz
```

1. Verify the signature. We generate [SLSA 3 provenance](https://slsa.dev) using
the OpenSSF's [slsa-framework/slsa-github-generator](https://github.com/slsa-framework/slsa-github-generator).
To verify our release, install the verification tool from [slsa-framework/slsa-verifier#installation](https://github.com/slsa-framework/slsa-verifier#installation)
and verify as follows:

```sh
```console
$ curl -sL https://github.com/google/go-containerregistry/releases/download/${VERSION}/multiple.intoto.jsonl > provenance.intoto.jsonl
$ # NOTE: You may be using a different architecture.
$ slsa-verifier-linux-amd64 verify-artifact go-containerregistry.tar.gz --provenance-path provenance.intoto.jsonl --source-uri github.com/google/go-containerregistry --source-tag "${VERSION}"
Expand All @@ -46,7 +46,7 @@ A collection of useful things you can do with `crane` is [here](recipes.md).
1. Unpack it in the PATH.

```sh
$ tar -zxvf go-containerregistry.tar.gz -C /usr/local/bin/ crane
tar -zxvf go-containerregistry.tar.gz -C /usr/local/bin/ crane
```

### Install manually
Expand All @@ -62,15 +62,15 @@ go install github.com/google/go-containerregistry/cmd/crane@latest
If you're macOS user and using [Homebrew](https://brew.sh/), you can install via brew command:

```sh
$ brew install crane
brew install crane
```

### Install on Arch Linux

If you're an Arch Linux user you can install via pacman command:

```sh
$ pacman -S crane
pacman -S crane
```

### Setup on GitHub Actions
Expand All @@ -79,7 +79,7 @@ You can use the [`setup-crane`](https://github.com/imjasonh/setup-crane) action
to install `crane` and setup auth to [GitHub Container
Registry](https://github.com/features/packages) in a GitHub Action workflow:

```
```yaml
steps:
- uses: imjasonh/[email protected]
```
Expand All @@ -88,7 +88,7 @@ steps:

You can also use crane as docker image

```sh
```console
$ docker run --rm gcr.io/go-containerregistry/crane ls ubuntu
10.04
12.04.5
Expand Down