-
Notifications
You must be signed in to change notification settings - Fork 72
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): adding more details to README (#578)
Co-authored-by: Hayk Sardaryan <[email protected]>
- Loading branch information
Showing
1 changed file
with
10 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
``` | ||
|