apache/pinot

Automate License and Notice Binary update manual step

Open

#15460 opened on Apr 3, 2025

View on GitHub
 (4 comments) (0 reactions) (1 assignee)Java (4,937 stars) (1,234 forks)batch import
good first issuehelp wantedstale

Description

Depndabot generally raises the PR to upgrade the dependency if a new version is available. This results in the License-binary and Notice-binary files not being updated. For the release process, we need to update these two files, and we are currently following a semi-manual process to do it. Refer here

This issue will try to automate the step.

Contributor guide

Tech stack
javashell
Domain
releaseci cd
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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
Understanding of Apache Pinot release processKnowledge of Gradle or Maven build scriptsFamiliarity with shell scriptingFamiliarity with LICENSE/NOTICE files in Apache projects
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the current manual process documented at the provided wiki link https://cwiki.apache.org/confluence/display/PINOT/Creating+an+Apache+Release#CreatinganApacheRelease UpdatingLICENSE binaryfile. Examine the existing CI/CD pipeline in the repository (e.g., GitHub Actions workflows) to identify where automation can be integrated. Consider writing a script (e.g., using Gradle or shell) that compares versions of dependencies and updates the LICENSE binary and NOTICE binary files accordingly. Also review any existing maintainer comments in the issue for specific requirements.