Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 3.23 KB

RELEASING.md

File metadata and controls

55 lines (34 loc) · 3.23 KB
Raw

Releasing the Connectors project

The version scheme we use is MAJOR.MINOR.PATCH.BUILD and stored in the VERSION file at the root of this repository.

Unified release

MAJOR.MINOR.PATCH should match the Elastic and Enterprise Search version it targets and the BUILD number should be set to 0 the day the Connectors release is created to be included with the Enterprise Search distribution.

For example, when shipping for 8.1.2, the version is 8.1.2.0.

To release Connectors:

  1. Make sure all tests and linter pass with make lint test
  2. Run make release
  3. Set the VERSION file to the new/incremented version on the release branch
  4. PR this change to the appropriate Connectors release branch

A package will be generated in dist/

Take care of the branching (minor releases only):

  • Increment the VERSION on main to match the next minor release
  • Create a new maintenance branch
  • Make sure the .backportrc.json is updated. The previous minor is added to targetBranchChoices and the new minor is used in branchLabelMapping

After the Elastic unified release is complete

  • Update the BUILD version (example PR). Note that the Connectors project does not immediately bump to the next PATCH version. That won't happen until that patch release's FF date.

Releasing docker images

To release the docker image, follow these steps:

  1. Make sure that you're on the right branch and VERSION file is correct: cat connectors/VERSION. The value in this file should be your expected release version - e.g. if you're releasing 8.12.2.1, then VERSION should also be 8.12.2.1.
  2. Go to https://buildkite.com/elastic, find "connectors-docker-build-publish" pipeline and trigger a Build:
  • Click on "New Build"
  • Enter a descriptive message, choose commit (or leave HEAD if you build the last commit of the branch) and enter the branch (in the example with 8.12.2.1 you would put 8.12 here)
  • Press "Create Build" and wait for the build to finish
  1. Tag the commit that was used for the image with git tag <tag_id> && git push origin <tag_id>. For the example above, tag_id would be v8.12.2.1
  2. Update connectors/VERSION file and bump the last part of the version by an increment and submit a PR with it. In the example above, the value would be 8.12.2.2.

In-Between releases

Sometimes, we need to release Connectors independently from Enterprise Search. For instance, if someone wants to use the project as an HTTP Service, and we have a bug fix we want them to have as soon as possible.

In that case, we increment the BUILD number, and follow the same release process than for the unified release.

So 8.1.2.1, 8.1.2.2 etc. On the next unified release, the version will be bumped to the next PATCH value, and BUILD set to 0

In-Between releases should never introduce new features since they will eventually be merged into the next PATCH release. New features are always done in Developer previews

Developer preview releases

For developer previews, we are adding a pre tag using an ISO8601 date. You can use make release_dev instead of make release in that case.