opensearch-project/OpenSearch

Verify that backwards-compatibility versions are in sync across branches in CI

Open

#2,533 opened on Mar 21, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (1,505 forks)batch import
Build Libraries & Interfacesenhancementgood first issuehacktoberfest

Repository metrics

Stars
 (8,123 stars)
PR merge metrics
 (Avg merge 5d 9h) (266 merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe.

When incrementing a version for OpenSearch we have to update multiple files across multiple branches.

These enable backwards-compatibility testing across multiple versions.

The process has been automated (https://github.com/opensearch-project/OpenSearch/blob/main/.github/workflows/version.yml), however it's brittle. It's also easy to make a mistake when making an unrelated change. As an example,. https://github.com/opensearch-project/OpenSearch/pull/2430 has fixed one of those mistakes.

Describe the solution you'd like Check version, constants and bcw versions in CI.

Additional context Discussed in https://github.com/opensearch-project/OpenSearch/pull/2532#issuecomment-1074251240

Contributor guide

Research direction
Review the version files (bwcVersions, version.properties, Version.java) and the existing version automation workflow (version.yml). Create a CI job that compares the versions across those files and fails if they don't match. Implement the check and add it to the CI pipeline.
Tech stack
java
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75