ddb21f969d
* I have explored the codebase and confirmed that the GitHub integration now relies on the `gh` CLI instead of a Personal Access Token (PAT) configured in the settings. The setup process is "just-in-time", prompting the user to install or authenticate the CLI when they attempt to create a Pull Request. I have updated the documentation to reflect these changes: 1. **`docs/integrations/github-integration.mdx`**: Rewrote the guide to explain the CLI-based workflow, including automatic setup on macOS and manual setup instructions for other platforms, as well as troubleshooting steps. 2. **`docs/getting-started.mdx`**: Updated the installation steps to remove the instruction to "Connect to GitHub in Settings" and instead mention the `gh` CLI requirement. 3. **`docs/configuration-customisation/global-settings.mdx`**: Removed the "GitHub Integration" section (since it no longer exists in Global Settings) and replaced it with a "Git Configuration" section describing the "Branch Prefix" setting, which is present in the UI. I also verified that `docs/core-features/completing-a-task.mdx` remains accurate with the new workflow. No images were needed as the process is now primarily CLI-driven or standard dialog-based, and I removed the outdated screenshots from the documentation files. I ran `pnpm run check` to ensure no regressions were introduced, and it passed successfully. ### Summary of Changes | File | Change | | :--- | :--- | | `docs/integrations/github-integration.mdx` | Rewritten to document `gh` CLI usage and troubleshooting | | `docs/getting-started.mdx` | Removed outdated "Connect GitHub" step; added CLI info | | `docs/configuration-customisation/global-settings.mdx` | Removed GitHub section; added Git Branch Prefix section | * The "Troubleshooting" section has been removed from `docs/integrations/github-integration.mdx`. * I have performed a comprehensive search for "github" across the documentation and codebase. I found and updated a few more references to ensure consistency: 1. **`docs/core-features/completing-a-task.mdx`**: Updated the link text to "Set up GitHub CLI integration" instead of "Set up GitHub authentication". 2. **`docs/index.mdx`**: Updated the Settings card description to remove "GitHub integration" and replace it with "git settings". 3. **`docs/configuration-customisation/global-settings.mdx`**: Updated the alt text of the settings screenshot to remove the mention of "GitHub integration settings". I verified other references in `docs/core-features/creating-tasks.mdx`, `docs/core-features/monitoring-task-execution.mdx`, and `docs/supported-coding-agents.mdx` and confirmed they are either correct (referring to platform features like polling or agents like Copilot) or generic examples that don't need changing. The documentation now fully reflects the shift to the CLI-based GitHub integration workflow.
69 lines
2.8 KiB
Plaintext
69 lines
2.8 KiB
Plaintext
---
|
|
title: "Completing a Task"
|
|
description: "Learn how to complete tasks by rebasing, merging, and managing pull requests directly from Vibe Kanban"
|
|
sidebarTitle: "Completing a Task"
|
|
---
|
|
|
|
When your task is finished, Vibe Kanban provides integrated git operations to keep your branch up-to-date and merge your work back into the base branch.
|
|
|
|
## Git Operations Header
|
|
|
|
At the top of the diff view, you'll see important branch information and actions:
|
|
|
|
<Frame>
|
|
<img src="/images/vk-diff-header.png" alt="Diff header showing branch information and action buttons" />
|
|
</Frame>
|
|
|
|
**Branch Information:**
|
|
- **Task branch**: The branch your task is working on
|
|
- **Target branch**: The branch you'll merge into (with cog button to change it)
|
|
- **Commits ahead**: Number of commits your branch has that aren't in the target
|
|
- **Commits behind**: Number of commits in the target that you don't have (enables rebase button when >0)
|
|
|
|
**Actions:**
|
|
- **Merge**: Merge your changes into the target branch
|
|
- **Create PR**: Create a pull request on GitHub
|
|
- **Rebase**: Update your branch with the latest changes from the target branch
|
|
|
|
## Rebase
|
|
|
|
Click **Rebase** to update your branch with the latest changes from the target branch. This keeps your branch up-to-date and maintains a clean history.
|
|
|
|
If conflicts occur, see [Resolving Rebase Conflicts](/core-features/resolving-rebase-conflicts).
|
|
|
|
## Merge
|
|
|
|
Click **Merge** to integrate your completed work into the target branch. Your task will automatically move to the **Done** column, and the worktree is cleaned up automatically. The branch remains until you manually delete it.
|
|
|
|
<Tip>
|
|
If you're working with GitHub, consider creating a pull request instead of merging directly. This allows for team review and CI checks.
|
|
</Tip>
|
|
|
|
## Pull Request Management
|
|
|
|
### Creating a Pull Request
|
|
|
|
Click **Create PR** to create a pull request on GitHub. The title and description are auto-populated from your task details.
|
|
|
|
<Frame>
|
|
<img src="/images/vk-pr-open.png" alt="Header showing disabled Push button after pull request creation" />
|
|
</Frame>
|
|
|
|
After creating the PR, the button changes to **Push** (initially disabled until you make more changes).
|
|
|
|
### Updating a Pull Request
|
|
|
|
When you continue working after creating a PR, the **Push** button becomes enabled. Click it to push your latest changes to the pull request.
|
|
|
|
<Frame>
|
|
<img src="/images/vk-pr-with-push.png" alt="Header showing enabled Push button with new changes ready" />
|
|
</Frame>
|
|
|
|
When your PR is merged on GitHub, your task automatically moves to **Done**.
|
|
|
|
## Related Documentation
|
|
|
|
- [Resolving Rebase Conflicts](/core-features/resolving-rebase-conflicts) - Handle conflicts during rebasing
|
|
- [GitHub Integration](/integrations/github-integration) - Set up GitHub CLI integration
|
|
- [Creating Projects](/core-features/creating-projects) - Configure base branches and project settings
|