Skip to content

Commit dd49555

Browse files
authored
feat: adds a development doc with the steps for a release (#89)
* feat: adds a development doc with the steps for a release
1 parent 2a0abec commit dd49555

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
2+
## Releasing
3+
4+
Releasing a version of the Lambda Extension is currently a three step manual process.
5+
6+
1. Tag the Release
7+
2. Create the Build Artifacts
8+
3. Add a Release via the Github UI
9+
10+
### Tag the Release
11+
12+
First, tag the release via your preferred tagging method. Tagging a release (v0.0.2) via the command line looks something like this.
13+
14+
% git clone [email protected]:elastic/apm-aws-lambda.git
15+
# ...
16+
% cd apm-aws-lambda
17+
% git checkout main
18+
% git tag v0.0.2
19+
% git push --tags
20+
Total 0 (delta 0), reused 0 (delta 0), pack-reused 0
21+
To github.com:elastic/apm-aws-lambda.git
22+
* [new tag] v0.0.2 -> v0.0.2
23+
24+
25+
### Create the Build Artifacts
26+
27+
Next, create the build artifacts for the release. These are go binaries of the Lambda Extension, built for both Intel and ARM architectures.
28+
29+
If you were creating the build artifacts for the v0.0.2 release, that might look something like this
30+
31+
32+
% GOARCH=arm64 make build
33+
% GOARCH=arm64 make zip
34+
% ls -1 bin/arm64.zip
35+
bin/arm64.zip
36+
% mv bin/arm64.zip bin/v0-0-2-linux-arm64.zip
37+
38+
% GOARCH=amd64 make build
39+
% GOARCH=amd64 make zip
40+
% ls -lh bin/amd64.zip
41+
% mv bin/amd64.zip bin/v0-0-2-linux-amd64.zip
42+
43+
### Add a Release via the Github UI
44+
45+
You can add a release via the GitHub UI by
46+
47+
1. Navigating to [the repo homepage](https://github.com/elastic/apm-aws-lambda/)
48+
49+
2. Clicking on [create new release](https://github.com/elastic/apm-aws-lambda/releases/new)
50+
51+
3. Selecting the Tag (tagged above)
52+
53+
4. Entering a release title, description, and binaries
54+
55+
5. Clicking on the Publish Release button

0 commit comments

Comments
 (0)