opensearch-project / opensearch-project/opensearch-java

[FEATURE] Improve Gradle release version logic

Open
#1,569 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
165
Forks
250
Avg merge
1d 18h
Merged PRs (30d)
26

Description

Is your feature request related to a problem?

Currently build.gradle.kts requires setting a VERSION environment variable to build release artifacts, otherwise it always appends -SNAPSHOT to the version defined in gradle.properties. This means that the release-drafter.yml workflow must work around this by parsing the gradle.properties file and then setting the VERSION environment variable.

What solution would you like?

This should be changed to instead use a build.snapshot property.

Optionally can still override the version property based on the tag that was pushed in workflow.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the version logic at build.gradle.kts line 37 and the version defined in gradle.properties. Then inspect .github/workflows/release-drafter.yml around line 35 to understand its current VERSION workaround. Done means snapshot behavior is controlled by build.snapshot, with the workflow able to override the version from the pushed tag as described.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, java
Domain
build-system, ci-cd, release
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.