Skip to content

Commit

Permalink
rename confusing properties/flags (#82)
Browse files Browse the repository at this point in the history
* Cleanup refactor, rename confusing config properties and flags while retaining backwards compatibility

* rename to builder

* Update docs and chains.yaml to non-deprecated

* Improve platforms flag description

* Update stale references to git-ref flag

* Add logs for github release fetches

* Remove github basic auth
  • Loading branch information
agouin authored Feb 1, 2023
1 parent 61e5c0c commit 9406f6b
Show file tree
Hide file tree
Showing 15 changed files with 705 additions and 552 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ go build
#### Example: build the docker image for gaia v6.0.0:

```bash
heighliner build -c gaia -v v6.0.0
heighliner build --chain gaia --git-ref v6.0.0
```

Docker image `heighliner/gaia:v6.0.0` will now be available in your local docker images
Expand All @@ -40,7 +40,7 @@ Docker image `gaia:local` will be built and stored in your local docker images.

```bash
# docker login ...
heighliner build -r ghcr.io/strangelove-ventures/heighliner -c gaia -v v6.0.0
heighliner build -r ghcr.io/strangelove-ventures/heighliner -c gaia -g v6.0.0
```

Docker image `ghcr.io/strangelove-ventures/heighliner/gaia:v6.0.0` will be built and pushed to ghcr.io
Expand Down Expand Up @@ -77,15 +77,15 @@ Customize the platform(s) to be built with the `--platform` flag.
#### Example: build x64 and arm64 docker images for gaia v7.0.1:

```bash
heighliner build -c gaia -v v7.0.1
heighliner build -c gaia -g v7.0.1
```

Docker images for `heighliner/gaia:v7.0.1` will now be available in your local docker. The manifest for the tag will contain both amd64 and arm64 images.

#### Example: Use custom buildkit server, build x64 and arm64 docker images for gaia v7.0.1, and push:

```bash
heighliner build -b --buildkit-addr tcp://192.168.1.5:8125 -c gaia -v v7.0.1 -r ghcr.io/strangelove-ventures/heighliner
heighliner build -b --buildkit-addr tcp://192.168.1.5:8125 -c gaia -g v7.0.1 -r ghcr.io/strangelove-ventures/heighliner
```

Docker images for `heighliner/gaia:v7.0.1` will be built on the remote buildkit server and then pushed to the container repository. The manifest for the tag will contain both amd64 and arm64 images.
Expand Down
6 changes: 3 additions & 3 deletions addChain.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ Please keep chains in alphabetical order.

`github-repo` -> The repo name of the location of the chain binary.

`language` -> Used in the Docker `FROM` argument to create a a docker base image. OPTIONS: "go, rust, nix, imported". Use "imported" if you are not able to build the chain binary from source and are importing a pre-made docker container.
`dockerfile` -> Which dockerfile strategy to use (folder names under dockerfile/). OPTIONS: `cosmos`, `cargo`, `imported`, or `none`. Use `imported` if you are importing an existing public docker image as a base for the heighliner image. Use `none` if you are not able to build the chain binary from source and need to download binaries into the image instead.

`build-env` -> Environment variables to be created during the build.

`pre-build` -> Any extra arguments needed to build the chain binary.

`build-target` -> The argument to call after `make` (language=golang), `cargo` (language=rust) or `nix` (language=nix).
`build-target` -> The build command specific to the chosen `dockerfile`. For `cosmos`, likely `make install`. For `cargo`, likely `build --release`.

`binaries` -> The location of where the the build target places the binarie(s). Adding a ":" after the path allows for the ability to rename the binary.

Expand All @@ -33,7 +33,7 @@ Please keep chains in alphabetical order.

Please check the image builds successfully before submitting PR:

`./heighliner build -c <CHAIN-NAME> -v <VERSION>
`./heighliner build -c <CHAIN-NAME> -g <BRANCH OR TAG>`

Ensure binary runs in image:

Expand Down
Loading

0 comments on commit 9406f6b

Please sign in to comment.