Skip to content

Commit

Permalink
chore(docs): adding more details to README (#578)
Browse files Browse the repository at this point in the history
Co-authored-by: Hayk Sardaryan <[email protected]>
  • Loading branch information
Hayk-S and Hayk-S authored Oct 28, 2022
1 parent 9d99ba7 commit ad08666
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,29 @@ The tools necessary to build, package and release Kong

All examples assume that Kong is a sibling directory of kong-build-tools and run from the kong-build-tools directory
unless otherwise specified. This behaviour can be adjusted by setting a `KONG_SOURCE_LOCATION` environment variable

```
cd ~
git clone [email protected]:Kong/kong.git
git clone [email protected]:Kong/kong-build-tools.git
cd kong-build-tools
```

```
# example of KONG_SOURCE_LOCATION usage for kong-ee
export KONG_SOURCE_LOCATION=/Users/kong/Documents/Kong-Repos/kong-ee
```
Packaging kong-ee additionally requires:

- A `GITHUB_TOKEN` environment variable with access to Kong's private github repositories
- `git checkout` to target kong-ee branch before starting.

Packaging arm64 architectures additionally requires:

- [Docker-machine](https://github.com/docker/machine)
- [Buildx Docker plugin](https://github.com/docker/buildx)
- AWS Credentials (or access via an instance profile)

Packaging kong-ee additionally requires:

- A `GITHUB_TOKEN` environment variable with access to Kong's private github repositories

## Building a Kong Package

```
Expand Down

0 comments on commit ad08666

Please sign in to comment.