Use new format for the balance snippets - #7204
Conversation
Regex replace: (?<=^-)( \(.*?\))(.*?)\.?$ with $2$1. in snippets/*.md excluding balance.*.md
Regex replace
^.*?\*\*(.*)\s\((\w{3}\d{4}).*
with
{% unit $2 %}
$1
{% endunit %}
in
snippets/*.md
same regex as non-balance
Simple = didn't handle multiline like the big SACU change snippet
regex replace
^- (.*)(?:.*\n){0,3}?(\{(?:.*\n){0,3}?.*endunit %\})
with
$2
$1
in
snippets/*.md
didn't regex it because it requires variable number of replacements which vscode/regex doesn't handle
📝 WalkthroughWalkthroughThe PR updates changelog snippets for SACU and unit balance changes, issue fixes, maintenance changes, and standardized formatting. ChangesChangelog updates
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 `@changelog/snippets/balance.7141.md`:
- Line 11: Update the wording in the Combatant and Rambo preset description by
replacing “high energy cost difference” with “a large difference in energy
cost,” while leaving the rest of the changelog text unchanged.
- Around line 159-163: Adjust the explanatory paragraph under “Added Resource
Allocation System” to use the same two-space list-item indentation as the
corresponding paragraph at Line 39, avoiding four leading spaces that may render
it as a code block; leave the surrounding list content unchanged.
In `@changelog/snippets/balance.7143.md`:
- Line 4: Update the changelog sentence in balance.7143.md to replace “outside
of later T3 stage” with a direct timing phrase such as “before T3 or during ACU
fights,” while preserving the rest of the Fire Beetle rebalance description.
🪄 Autofix
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: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 55b68eb4-9f93-41b5-9df0-d5a0c9cf118e
📒 Files selected for processing (24)
changelog/snippets/balance.7141.mdchangelog/snippets/balance.7143.mdchangelog/snippets/balance.7146.mdchangelog/snippets/balance.7147.mdchangelog/snippets/balance.7165.mdchangelog/snippets/balance.7167.mdchangelog/snippets/balance.7196.mdchangelog/snippets/fix.6882.mdchangelog/snippets/fix.7051.mdchangelog/snippets/fix.7057.mdchangelog/snippets/fix.7136.mdchangelog/snippets/fix.7138.mdchangelog/snippets/fix.7153.mdchangelog/snippets/fix.7159.mdchangelog/snippets/fix.7162.mdchangelog/snippets/fix.7177.mdchangelog/snippets/fix.7178.mdchangelog/snippets/other.6882.mdchangelog/snippets/other.7012.mdchangelog/snippets/other.7045.mdchangelog/snippets/other.7052.mdchangelog/snippets/other.7155.mdchangelog/snippets/other.7166.mdchangelog/snippets/other.7176.md
|
|
||
| Due to costing less, the buildpower of non-UEF SACUs is reduced (engi presets keep their buildpower). UEF keeps their buildpower because they have a weaker engineer preset, the most expensive base SACU, a T4 that struggles with pushing, and unique ravagers. | ||
|
|
||
| Combatant and Rambo presets are separated by a high energy cost difference and Rambos get a mass cost reduction. This allows combatants to help with a faction's early issues, while Rambos play a role in the late game by being efficient but high infrastructure cost combat units, and highly versatile engineering units that can mitigate the dominance of air and the risk of reclaim donations. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use a clear phrase for the energy-cost difference.
Line 11 uses high energy cost difference, which is ambiguous. Replace it with a large difference in energy cost.
Proposed wording
-Combatant and Rambo presets are separated by a high energy cost difference and Rambos get a mass cost reduction. This allows combatants to help with a faction's early issues, while Rambos play a role in the late game by being efficient but high infrastructure cost combat units, and highly versatile engineering units that can mitigate the dominance of air and the risk of reclaim donations.
+Combatant and Rambo presets have a large difference in energy cost, and Rambo presets receive a mass cost reduction. This allows combatants to help with a faction's early issues, while Rambo presets play a role in the late game by being efficient but high-infrastructure-cost combat units, and highly versatile engineering units that can mitigate the dominance of air and the risk of reclaim donations.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Combatant and Rambo presets are separated by a high energy cost difference and Rambos get a mass cost reduction. This allows combatants to help with a faction's early issues, while Rambos play a role in the late game by being efficient but high infrastructure cost combat units, and highly versatile engineering units that can mitigate the dominance of air and the risk of reclaim donations. | |
| Combatant and Rambo presets have a large difference in energy cost, and Rambo presets receive a mass cost reduction. This allows combatants to help with a faction's early issues, while Rambo presets play a role in the late game by being efficient but high-infrastructure-cost combat units, and highly versatile engineering units that can mitigate the dominance of air and the risk of reclaim donations. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...nt and Rambo presets are separated by a high energy cost difference and Rambos get a mass c...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🤖 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 `@changelog/snippets/balance.7141.md` at line 11, Update the wording in the
Combatant and Rambo preset description by replacing “high energy cost
difference” with “a large difference in energy cost,” while leaving the rest of
the changelog text unchanged.
Source: Linters/SAST tools
| - Added Resource Allocation System: | ||
|
|
||
| Seraphim players have continued to struggle with the ability to build a mobile economy because the stats were balanced around the high buildpower of Seraphim SACU spam compared to other factions' RAS SACUs. Since players aren't using this, the RAS upgrade is replacing the SACU's increased base production and base cost. | ||
|
|
||
| - Slot: Right arm (teleport and overcharge arm) |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Keep the explanatory paragraph at list-item indentation.
Line 161 uses four leading spaces after a blank line. Markdown can render it as a code block instead of normal prose. Use the same two-space indentation as the explanatory paragraph at Line 39.
Proposed indentation fix
- Seraphim players have continued to struggle with the ability to build a mobile economy because the stats were balanced around the high buildpower of Seraphim SACU spam compared to other factions' RAS SACUs. Since players aren't using this, the RAS upgrade is replacing the SACU's increased base production and base cost.
+ Seraphim players have continued to struggle with the ability to build a mobile economy because the stats were balanced around the high buildpower of Seraphim SACU spam compared to other factions' RAS SACUs. Since players aren't using this, the RAS upgrade is replacing the SACU's increased base production and base cost.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Added Resource Allocation System: | |
| Seraphim players have continued to struggle with the ability to build a mobile economy because the stats were balanced around the high buildpower of Seraphim SACU spam compared to other factions' RAS SACUs. Since players aren't using this, the RAS upgrade is replacing the SACU's increased base production and base cost. | |
| - Slot: Right arm (teleport and overcharge arm) | |
| - Added Resource Allocation System: | |
| Seraphim players have continued to struggle with the ability to build a mobile economy because the stats were balanced around the high buildpower of Seraphim SACU spam compared to other factions' RAS SACUs. Since players aren't using this, the RAS upgrade is replacing the SACU's increased base production and base cost. | |
| - Slot: Right arm (teleport and overcharge arm) |
🤖 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 `@changelog/snippets/balance.7141.md` around lines 159 - 163, Adjust the
explanatory paragraph under “Added Resource Allocation System” to use the same
two-space list-item indentation as the corresponding paragraph at Line 39,
avoiding four leading spaces that may render it as a code block; leave the
surrounding list content unchanged.
| {% unit XRL0302 %} | ||
| Fire Beetle: T2 Mobile Bomb | ||
| {% endunit %} | ||
| Rebalance Fire Beetle with removed cloak to make it interactable outside of later T3 stage or in ACU fights (#7143). |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Clarify the Fire Beetle timing description.
Line 4 uses outside of later T3 stage. Replace it with a direct phrase such as before T3 or during ACU fights.
Proposed wording
-Rebalance Fire Beetle with removed cloak to make it interactable outside of later T3 stage or in ACU fights (`#7143`).
+Rebalance Fire Beetle after removing its cloak so it remains interactable before T3 or during ACU fights (`#7143`).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Rebalance Fire Beetle with removed cloak to make it interactable outside of later T3 stage or in ACU fights (#7143). | |
| Rebalance Fire Beetle after removing its cloak so it remains interactable before T3 or during ACU fights (`#7143`). |
🧰 Tools
🪛 LanguageTool
[style] ~4-~4: This phrase is redundant. Consider using “outside”.
Context: ...h removed cloak to make it interactable outside of later T3 stage or in ACU fights (#7143)...
(OUTSIDE_OF)
🤖 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 `@changelog/snippets/balance.7143.md` at line 4, Update the changelog sentence
in balance.7143.md to replace “outside of later T3 stage” with a direct timing
phrase such as “before T3 or during ACU fights,” while preserving the rest of
the Fire Beetle rebalance description.
Source: Linters/SAST tools
|
You can run the documentation website locally as explained here: https://faforever.github.io/fa/documentation |
3 participants
Description of the proposed changes
Migrates the snippets to the new format.
I didn't change the content of the snippets although I think the SACU snippet could be written better.
Testing done on the proposed changes
I don't know how to preview the generated changelog html.
Additional context
Requested from #7202
The commit descriptions include the regex I used, so I suggest reviewing by commit and checking the regex. It may also be interesting to process old changelogs with that regex.
Checklist
- [ ] Changes are annotated, including comments where useful- [ ] Changes are documented in a changelog snippet according to the guidelines.Summary by CodeRabbit
Balance Changes
Bug Fixes
Documentation