add option to keep debug symbols for build #84
Conversation
WalkthroughThe changes add a new configuration option, Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant Runner as GitHub Action Runner
participant Script as steam_deploy.sh
Dev->>Runner: Set debugBranch parameter (true/false)
Runner->>Script: Pass environment variable debugBranch
Script->>Script: Evaluate debugBranch value
alt Debug enabled
Script->>Script: Set debugExcludes to ""
else Debug disabled
Script->>Script: Set debugExcludes with exclusion patterns
end
Script->>Runner: Generate depot manifest with appropriate exclusions
Suggested reviewers
Poem
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
steam_deploy.sh (1)
1-7: 🛠️ Refactor suggestionInitialize
debugBranchto Prevent Unbound Variable ErrorsSince the script is running with
set -euo pipefail, referencing an unset variable likedebugBranchcan cause a runtime error. Although theaction.ymlsets a default, it is safer to initialize this variable explicitly in the script. Consider adding an initialization near the top of the file.Proposed diff (insert after line 3):
IFS=$'\n\t' +debugBranch=${debugBranch:-false}🧰 Tools
🪛 Shellcheck (0.10.0)
[warning] 7-7: rootPath is referenced but not assigned.
(SC2154)
🧹 Nitpick comments (3)
README.md (2)
185-187: Documentation Clarity fordebugBranchParameterThe new section for debugBranch clearly explains that when set to true, debug files will not be excluded from the upload. This documentation is concise and aligns well with the PR objective of enabling debug symbol retention.
191-191: Adjust Heading Level for ConsistencyThe heading “#### Excluded Files / Folders” immediately following a “## Other Notes” section violates the one-level increment guideline. Consider changing it to “### Excluded Files / Folders” for better readability and to satisfy markdownlint recommendations.
Proposed diff:
-#### Excluded Files / Folders +### Excluded Files / Folders🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
191-191: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
steam_deploy.sh (1)
44-48: Conditional Setting of Debug ExclusionsThe new conditional block that determines the value of
debugExcludesbased ondebugBranchis implemented correctly. WhendebugBranchis true, debug exclusions are disabled (empty string); otherwise, the file exclusion directives are applied.🧰 Tools
🪛 Shellcheck (0.10.0)
[warning] 44-44: debugBranch is referenced but not assigned.
(SC2154)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
README.md(1 hunks)action.yml(2 hunks)steam_deploy.sh(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
191-191: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
🪛 Shellcheck (0.10.0)
steam_deploy.sh
[warning] 44-44: debugBranch is referenced but not assigned.
(SC2154)
🔇 Additional comments (1)
action.yml (1)
85-89: New Input ParameterdebugBranchConfigurationThe new input parameter debugBranch is integrated correctly. It is declared as not required with a default of false and includes an appropriate description. The configuration is consistent with the intended use in both the documentation and the deployment script.
Changes
Checklist
Summary by CodeRabbit