Skip to content

feat: adds a development doc with the steps for a release #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 21, 2021
Merged

feat: adds a development doc with the steps for a release #89

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ede3de
feat: adds a development doc with the steps for a release
Dec 3, 2021
d6292bd
feat: finished sentance
Dec 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions apm-lambda-extension/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 [email protected]: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 the Publish Release button