Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

triagebot: Add documentation for transfer command. #741

Merged
merged 2 commits into from
May 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
- [Documentation Updates](./triagebot/doc-updates.md)
- [GitHub Releases](./triagebot/github-releases.md)
- [Glacier](./triagebot/glacier.md)
- [Issue Transfer](./triagebot/transfer.md)
- [Labeling](./triagebot/labeling.md)
- [Major Changes](./triagebot/major-changes.md)
- [Mentions](./triagebot/mentions.md)
Expand Down
36 changes: 36 additions & 0 deletions src/triagebot/transfer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Issue Transfer

The `transfer` command allows you to transfer a GitHub issue from one repository to another.

## Usage

To transfer an issue to another repository, enter a comment with the form:

`@rustbot transfer <repository-name>`

It is recommended to also include a comment explaining why you are transferring. For example:

```
Transferring to rust-lang/cargo since this is an issue with how cargo
implements diagnostic reports.

@rustbot transfer cargo
```

**IMPORTANT: There will be no visual indication that the issue is being transferred.** Due to GitHub API limitations, you will not see any activity. **You must reload the page** to view the issue in its new location. It may take a few moments for GitHub to transfer all the data.

**WARNING:** Transferring is a partially destructive command. For example, labels and milestones that don't exist in the target repository will be removed from the issue.

The transfer command is limited to team members of the rust-lang org, and transfers can only happen to repositories in the rust-lang org.

## Configuration

The source repository must have an empty `transfer` table to enable transfers *from* that repository. Issues can be transferred to any repository in the rust-lang org.

```toml
[transfer]
```

## Implementation

See [`parser/src/command/transfer.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/parser/src/command/transfer.rs) and [`src/handlers/transfer.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/transfer.rs).
Loading