Skip to content

Commit

Permalink
Add release docs
Browse files Browse the repository at this point in the history
  • Loading branch information
navarone-feekery committed Sep 5, 2024
1 parent 3683c98 commit 0119e95
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
1 change: 1 addition & 0 deletions .buildkite/release-pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ steps:
value: "true"
- label: "False"
value: "false"
- wait: ~
# ----
# Docker builds for amd64
# ----
Expand Down
26 changes: 26 additions & 0 deletions docs/RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Releasing

The version scheme we use is **MAJOR.MINOR.PATCH** and stored in the [product_version](../product_version) file at the root of this repository.

Open Crawler follows its own release versioning and does not follow the Elastic stack unified release schedule or versioning.

## How to release

Releasing is done entirely through Buildkite.
The Open Crawler build can be found here: https://buildkite.com/elastic/crawler-docker-build-publish

Builds will only run from a versioned branch.

Build steps:

1. Click `New Build`
2. Enter a message (e.g. `x.y release`)
3. Choose a commit
- the default `HEAD` is usually fine
4. Choose a version branch with the pattern `x.y`
- Builds will only run from a versioned branch, you cannot build from `main`
5. Click `Create Build`
6. Wait a minute for the Buildkite configuration to be loaded
- When it has loaded, a `Build Information` button will appear
7. Enter the build information
8. Wait for the build to finish

0 comments on commit 0119e95

Please sign in to comment.