From 1ede3dec8cc9ffbff42879d0c3e25e3344e35077 Mon Sep 17 00:00:00 2001 From: Alan Storm Date: Thu, 2 Dec 2021 16:45:59 -0800 Subject: [PATCH 1/2] feat: adds a development doc with the steps for a release --- apm-lambda-extension/DEVELOPMENT.md | 55 +++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 apm-lambda-extension/DEVELOPMENT.md diff --git a/apm-lambda-extension/DEVELOPMENT.md b/apm-lambda-extension/DEVELOPMENT.md new file mode 100644 index 00000000..90852368 --- /dev/null +++ b/apm-lambda-extension/DEVELOPMENT.md @@ -0,0 +1,55 @@ + +## Releasing + +Releasing a version of the Lambda Extension is currently a three step manual process. + +1. Tag the Release +2. Create the Build Artifacts +3. Add a Release via the Github UI + +### Tag the Release + +First, tag the release via your preferred tagging method. Tagging a release (v0.0.2) via the command line looks something like this. + + % git clone git@github.com:elastic/apm-aws-lambda.git + # ... + % cd apm-aws-lambda + % git checkout main + % git tag v0.0.2 + % git push --tags + Total 0 (delta 0), reused 0 (delta 0), pack-reused 0 + To github.com:elastic/apm-aws-lambda.git + * [new tag] v0.0.2 -> v0.0.2 + + +### Create the Build Artifacts + +Next, create the build artifacts for the release. These are go binaries of the Lambda Extension, built for both Intel and ARM architectures. + +If you were creating the build artifacts for the v0.0.2 release, that might look something like this + + + % GOARCH=arm64 make build + % GOARCH=arm64 make zip + % ls -1 bin/arm64.zip + bin/arm64.zip + % mv bin/arm64.zip bin/v0-0-2-linux-arm64.zip + + % GOARCH=amd64 make build + % GOARCH=amd64 make zip + % ls -lh bin/amd64.zip + % mv bin/amd64.zip bin/v0-0-2-linux-amd64.zip + +### Add a Release via the Github UI + +You can add a release via the GitHub UI by + +1. Navigating to [the repo homepage](https://github.com/elastic/apm-aws-lambda/) + +2. Clicking on [create new release](https://github.com/elastic/apm-aws-lambda/releases/new) + +3. Selecting the Tag (tagged above) + +4. Entering a release title, description, and binaries + +5. Clicking on \ No newline at end of file From d6292bd80fa6a16b0bb253e497e952f75370d3bb Mon Sep 17 00:00:00 2001 From: Alan Storm Date: Tue, 21 Dec 2021 08:17:53 -0800 Subject: [PATCH 2/2] feat: finished sentance --- apm-lambda-extension/DEVELOPMENT.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/apm-lambda-extension/DEVELOPMENT.md b/apm-lambda-extension/DEVELOPMENT.md index 90852368..95bd15d7 100644 --- a/apm-lambda-extension/DEVELOPMENT.md +++ b/apm-lambda-extension/DEVELOPMENT.md @@ -21,10 +21,10 @@ First, tag the release via your preferred tagging method. Tagging a release (v0 To github.com:elastic/apm-aws-lambda.git * [new tag] v0.0.2 -> v0.0.2 - + ### Create the Build Artifacts -Next, create the build artifacts for the release. These are go binaries of the Lambda Extension, built for both Intel and ARM architectures. +Next, create the build artifacts for the release. These are go binaries of the Lambda Extension, built for both Intel and ARM architectures. If you were creating the build artifacts for the v0.0.2 release, that might look something like this @@ -52,4 +52,4 @@ You can add a release via the GitHub UI by 4. Entering a release title, description, and binaries -5. Clicking on \ No newline at end of file +5. Clicking on the Publish Release button