Fixed missing totp parameter
Changes
steam-deploy supports totp, but the script only checks for the test login. The actual upload command then doesn't utilize the neccessary +set_steam_guard_code parameter. This change adds that.
Checklist
- [x] Read the contribution guide and accept the code of conduct
- [X] Readme (updated or not needed)
- [X] Tests (added, updated or not needed)
Summary by CodeRabbit
- New Features
- Enhanced the login process for Steam deployments, allowing for dynamic authentication based on the validity of security credentials. Improved error handling ensures detailed logs and outputs are consistently available during login attempts.
Walkthrough
The changes modify the steam_deploy.sh script to enhance the login process for Steam deployment. A conditional structure is introduced to check the validity of the steam_totp variable. Depending on its value, the script either includes the Steam Guard code in the login command or falls back to a simpler login method. Additionally, error handling is improved to ensure detailed logging occurs for both login attempts, maintaining the overall functionality of the script.
Changes
| File | Change Summary |
|---|---|
| steam_deploy.sh | Introduces conditional checks for steam_totp validity; enhances error handling and logging for login attempts. |
Sequence Diagram(s)
sequenceDiagram
participant S as steam_deploy.sh
participant C as steamcmd
S->>S: Check steam_totp validity
alt If steam_totp is valid
S->>C: Execute steamcmd with Steam Guard code
else
S->>C: Execute steamcmd without Steam Guard code
end
C-->>S: Return login result
S->>S: Log error details if login fails
Poem
I'm a playful rabbit in a code-filled lair,
Hopping through scripts with a cheerful flair.
Steam login's now flexible on its merry way,
Guard code twirls in only when it's okay.
With every build, I bounce and sing—
Cheers to changes that make our code spring!
[!TIP]
⚡💬 Agentic Chat (Pro Plan, General Availability)
- We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and generate unit testing code.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
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)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai planto trigger planning for file edits and PR creation.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
I've had a closer look and my inital commit didn't do the job proper. The problem seems to be that the verifying the TOTP with a test login takes too longl, so that the code cycles once the real upload step comes around. I've mitigated that by excluding the test-login step for TOTP. @webbertakken What do you think?
Closing in favor of https://github.com/game-ci/steam-deploy/pull/87