opensearch-project/OpenSearch

[Version Bump Bot] Enhance the version bump bot to update the version in README and CHANGELOG

Open

#8,851 opened on Jul 24, 2023

View on GitHub
 (5 comments) (1 reaction) (1 assignee)Java (1,505 forks)batch import
enhancementgood first issue

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.

  • The version bump bot increments the versions once a new tag is cut/released
  • The bump does not update the versions within README.md and CHANGELOG.md

Describe the solution you'd like

Describe alternatives you've considered

  • Manually updating every time a new version is released.

Additional context

Contributor guide

Research direction
Examine the existing version bump bot script and the referenced PR #8846 to understand the pattern for updating README and CHANGELOG. Then modify the version.yml workflow to include steps that read the current version from the tag, update the README version badge and CHANGELOG entries, and commit the changes.
Tech stack
java
Domain
backenddevops
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.
Half day
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
GitGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60