Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 2.43 KB
Raw

Contributing to Elastic Maps Service Landing Page

New features and bug fixes

All pull requests must be targeted to the master branch.

If multiple releases are affected:

  1. Open a PR against the master branch.
  2. After the PR is merged, Backport the commit(s) to the affected branches.
  3. After all PRs to release branches have been merged and their respective Jenkins jobs (ex. elastic / ems-landing-page # v7.2 - stage) have completed successfully review the staged changes at https://maps-staging.elastic.co/{some-release-branch} (ex. 7.2).
  4. If the staged changes are ok, deploy the changes to production by logging into this Jenkins job and choose "Build with Parameters".

New Releases

New releases of EMS Landing Page match minor releases of the Elastic Stack.

To add a new release:

  1. Open a PR with the following changes:
    1. Create a new config in the .ci/jobs directory for a new release branch.
    2. Change the EMS_VERSION in config.json.
    3. Upgrade the @elastic/ems-client dependency.
    4. Bump the verison in package.json.
    5. Add the new version to .backportrc.json.
  2. After the PR is merged, create the new release branch from the master branch.

After release:

  1. Open a PR to change the default root_branch to the current release branch (ex. v7.4).
  2. After merging the PR, backport the commit to the respective release branch and merge.
  3. Wait for the elastic+ems-landing-page+jjbb Jenkins job to update.
  4. Then log into this Jenkins job and choose "Build with Parameters". This will update https://maps.elastic.co to the current release.

Backporting

Commits can be backported to previous branches using the backport tool. Backport automatically applies the commit to the selected branches and opens pull requests. It may be necessary to backport bug fixes and dependency upgrades to multiple branches.

Backporting can also introduce merge conflicts which must be resolved before continuing. Due to our current lack of automated tests, backport PRs should be tested locally before merging.