docs(release): manual NOTICE/license review step pre-Testing#2985
Merged
bjagg merged 3 commits intoMay 13, 2026
Conversation
Problem: the Gradle build does not wire any equivalent of Maven's notice:generate / license:format / javadoc:fix. Operators following this guide had no prompt to review NOTICE or to check that newly-added files carry the Apache license header, and that gap is a known release-quality risk surfaced by the cross-walk against the Maven portlet release guide. Goal: give release operators an explicit step to perform the manual review until Gradle tooling for this is added in a follow-up. Changes: - add a "Review NOTICE and License Headers" section between "Review Dependencies" and "Testing" - cross-link the Maven release guide that has the automated equivalent - include a quick grep heuristic for missing headers on changed files
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/developer/other/RELEASE.md, between "Review Dependencies" and "Testing"Why
The Maven-based components in the ecosystem have automated NOTICE regeneration and license-header enforcement via
mvn notice:generate/mvn license:format/mvn javadoc:fix. uPortal's Gradle build has no equivalent tooling wired in — so the release guide currently provides no prompt for the operator to do the equivalent review by hand. This is a known release-quality risk that surfaced while cross-walking the two release guides.Until a Gradle equivalent of those plugins is wired in (separate work, separate PR), this PR provides an explicit manual review step so the gap is at least visible to operators.
Test plan
docs/developer/other/RELEASE.mdon GitHub and confirm the new section appears between "Review Dependencies" and "Testing"git diff/grepheuristic snippet renders inside the markdown list correctly