Repository navigation
LCORE-2978: Added Release Jiras - #2095
Merged
Merged
Conversation
Contributor
WalkthroughThis PR modifies Changesfile-jiras.sh Enhancements
Estimated code review effort: 3 (Moderate) | ~20 minutes Release JIRA Templates
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@dev-tools/file-jiras.sh`:
- Around line 13-20: The usage/help text for file-jiras.sh currently describes
only the Epic-based flow, but it also supports a direct filing path when the
document includes no-epic. Update the script’s top-level flow description and
any help/usage output referenced by the main flow comments so they clearly
distinguish the default Epic-first behavior from the no-epic case; point readers
to the existing ticket-parsing and filing flow in file-jiras.sh so release
templates are discoverable.
- Around line 72-78: Validate --var entries in file-jiras.sh against the
supported placeholder syntax before appending to PLACEHOLDER_VARS: the current
argument parsing in the --var case accepts any KEY=VALUE, but only uppercase
brace-style placeholders are actually substituted later. Update the --var
handling so it rejects unsupported keys like empty names or lowercase keys up
front, and align the same validation in the related parsing block referenced by
the duplicate location. Keep the checks near the existing --var case and reuse
the same placeholder rules used by the warning/substitution logic.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 1ab774af-766c-472e-ad50-0d3e11a5f213
📒 Files selected for processing (2)
dev-tools/file-jiras.shdev-tools/release-jiras.md
📜 Review details
⏰ Context from checks skipped due to timeout. (15)
- GitHub Check: check_dependencies
- GitHub Check: integration_tests (3.13)
- GitHub Check: integration_tests (3.12)
- GitHub Check: Pylinter
- GitHub Check: build-pr
- GitHub Check: unit_tests (3.12)
- GitHub Check: unit_tests (3.13)
- GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-0-7-on-pull-request
- GitHub Check: E2E Tests for Lightspeed Evaluation job
- GitHub Check: E2E: library mode / ci / group 3
- GitHub Check: E2E: server mode / ci / group 2
- GitHub Check: E2E: library mode / ci / group 2
- GitHub Check: E2E: server mode / ci / group 3
- GitHub Check: E2E: library mode / ci / group 1
- GitHub Check: E2E: server mode / ci / group 1
🔇 Additional comments (2)
dev-tools/release-jiras.md (1)
1-211: LGTM!dev-tools/file-jiras.sh (1)
34-42: LGTM!Also applies to: 47-59, 179-179, 189-197, 316-323, 337-340, 349-352, 405-407, 458-460, 773-773
Comment on lines
13
to
+20
| # The script: | ||
| # 1. Parses JIRA sections from the spike doc (### LCORE-???? headings) | ||
| # 2. Auto-generates an Epic stub (ticket #0) | ||
| # 3. Reads <!-- type: Task/Story/Epic --> metadata from each ticket | ||
| # 4. Opens an interactive menu: view, edit, drop, file | ||
| # 5. Files Epic first, then children under it | ||
| # 6. Links spike ticket to Epic with "Informs" relationship | ||
| # 1. Replaces {KEY} placeholders with --var values (if any) | ||
| # 2. Parses JIRA sections from the doc (### LCORE-???? headings) | ||
| # 3. Auto-generates an Epic stub (ticket #0) | ||
| # 4. Reads <!-- type: Task/Story/Epic --> metadata from each ticket | ||
| # 5. Opens an interactive menu: view, edit, drop, file | ||
| # 6. Files Epic first, then children under it | ||
| # 7. Links spike ticket to Epic with "Informs" relationship |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Document the no-epic flow in usage/help.
The top-level flow still says the script always auto-generates/files an Epic and links the feature ticket to it, but <!-- no-epic --> files tickets directly under the feature ticket. Add a short help/doc note so release templates are discoverable and the flow description is conditional.
Also applies to: 43-46
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@dev-tools/file-jiras.sh` around lines 13 - 20, The usage/help text for
file-jiras.sh currently describes only the Epic-based flow, but it also supports
a direct filing path when the document includes no-epic. Update the script’s
top-level flow description and any help/usage output referenced by the main flow
comments so they clearly distinguish the default Epic-first behavior from the
no-epic case; point readers to the existing ticket-parsing and filing flow in
file-jiras.sh so release templates are discoverable.
Comment on lines
+72
to
+78
| --var) | ||
| [ $# -ge 2 ] || { echo "Error: --var requires KEY=VALUE"; exit 1; } | ||
| case "$2" in | ||
| *=*) PLACEHOLDER_VARS+=("$2") ;; | ||
| *) echo "Error: --var value must be KEY=VALUE (got '$2')"; exit 1 ;; | ||
| esac | ||
| shift 2 ;; |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Validate --var keys against the supported placeholder syntax.
--var =foo or --var x=1 currently passes argument parsing, but the warning regex only treats {UPPER_SNAKE} as placeholders. Reject unsupported keys up front to avoid confusing no-op substitutions.
Proposed fix
--var)
[ $# -ge 2 ] || { echo "Error: --var requires KEY=VALUE"; exit 1; }
case "$2" in
- *=*) PLACEHOLDER_VARS+=("$2") ;;
+ *=*)
+ key="${2%%=*}"
+ case "$key" in
+ ''|*[!A-Z0-9_]*|[0-9_]*)
+ echo "Error: --var key must match [A-Z][A-Z0-9_]* (got '$key')"
+ exit 1
+ ;;
+ esac
+ PLACEHOLDER_VARS+=("$2")
+ ;;
*) echo "Error: --var value must be KEY=VALUE (got '$2')"; exit 1 ;;
esac
shift 2 ;;Also applies to: 189-196
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@dev-tools/file-jiras.sh` around lines 72 - 78, Validate --var entries in
file-jiras.sh against the supported placeholder syntax before appending to
PLACEHOLDER_VARS: the current argument parsing in the --var case accepts any
KEY=VALUE, but only uppercase brace-style placeholders are actually substituted
later. Update the --var handling so it rejects unsupported keys like empty names
or lowercase keys up front, and align the same validation in the related parsing
block referenced by the duplicate location. Keep the checks near the existing
--var case and reuse the same placeholder rules used by the warning/substitution
logic.
3 of 19 tasks
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
2 participants
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.
Description
Add a reusable release checklist template (
dev-tools/release-jiras.md) and extendfile-jiras.shwith--var KEY=VALUEplaceholder substitution so the same template can be used for every release by supplying version numbers at invocation time. Also introduces the<!-- no-epic -->directive to skip auto-Epic generation, allowing tickets to be filed directly under a parent feature ticket — appropriate for release checklists that don't need an Epic wrapper.Type of change
Tools used to create PR
Identify any AI code assistants used in this PR (for transparency and review context)
Related Tickets & Documents
Checklist before requesting a review
Testing
file-jiras.sh --parse-onlyonrelease-jiras.mdwith--varsubstitutions to verify placeholder replacement,<!-- no-epic -->parsing, and correct ticket file output--vararguments are omittedSummary by CodeRabbit
New Features
Bug Fixes