Skip to content

Conversation

@Matovidlo
Copy link
Contributor

Jira issue(s): PSGO-1086

Documents the new --cleanup-rename-conflicts flag added to the kbc pull command in keboola/keboola-as-code#2425. This flag handles rename conflicts during pull operations specifically for UI-only DevOps workflows.

Changes:

  • Pull command documentation: Added --cleanup-rename-conflicts flag to options section with description and prominent warning about file deletion
  • DevOps use cases: Added new "UI-Only Sync Workflow" section explaining when and how to use the flag, including:
    • Explanation of rename conflicts in chained rename scenarios (A→B, C→A)
    • Usage instructions for UI-only workflows
    • Clear warnings about when NOT to use this flag
    • Data loss warnings since conflicting files are permanently removed

Review focus areas:

  • Technical accuracy: Verify the flag description matches actual implementation behavior from the source PR
  • Warning prominence: Check if warnings about permanent file deletion are sufficiently clear and visible
  • Use case boundaries: Ensure the distinction between UI-only vs Git-based workflows is clear
  • Markdown rendering: Verify alert boxes and formatting render correctly on the actual documentation site

Key safety consideration: This flag enables destructive operations (removes conflicting files) so accuracy of warnings and use case descriptions is critical.

Link to Devin run: https://app.devin.ai/sessions/ee80f1cc32794834b1a6aa3961fa4608
Requested by: @Matovidlo

- Add --cleanup-rename-conflicts option to pull command documentation
- Add UI-Only Sync Workflow section to DevOps use cases
- Include warnings about file recovery and when to use/not use this flag
- Explain rename conflict scenarios and cleanup mode behavior

Related to PSGO-1086 and implementation PR keboola/keboola-as-code#2425

Co-Authored-By: Martin Vasko <Matovidlo2@gmail.com>
@devin-ai-integration
Copy link
Contributor

devin-ai-integration bot commented Oct 2, 2025

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@Matovidlo Matovidlo requested a review from Copilot October 2, 2025 06:37
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR documents the new --cleanup-rename-conflicts flag for the kbc pull command to help users handle rename conflicts in UI-only DevOps workflows. The flag provides a solution for chained rename scenarios that occur when configurations are renamed through the Keboola UI interface.

  • Added comprehensive documentation for the --cleanup-rename-conflicts flag with usage examples and safety warnings
  • Created a new "UI-Only Sync Workflow" section explaining when and how to use the flag
  • Included prominent warnings about permanent file deletion and clear guidance on when NOT to use the flag

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
cli/commands/sync/pull/index.md Added flag documentation with description and warning alert box
cli/devops-use-cases/index.md Added comprehensive use case section with examples and safety guidelines

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@Matovidlo Matovidlo marked this pull request as ready for review October 2, 2025 06:41
@Matovidlo Matovidlo merged commit 7c90dce into main Oct 2, 2025
1 of 2 checks passed
@Matovidlo Matovidlo deleted the devin/PSGO-1086-1759383894-document-cleanup-rename-conflicts branch October 2, 2025 07:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants