Skip to content

Commit 32d934e

Browse files
committed
triagebot: Add documentation for transfer command.
1 parent 6dd5294 commit 32d934e

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

src/SUMMARY.md

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
- [Documentation Updates](./triagebot/doc-updates.md)
2121
- [GitHub Releases](./triagebot/github-releases.md)
2222
- [Glacier](./triagebot/glacier.md)
23+
- [Issue Transfer](./triagebot/transfer.md)
2324
- [Labeling](./triagebot/labeling.md)
2425
- [Major Changes](./triagebot/major-changes.md)
2526
- [Mentions](./triagebot/mentions.md)

src/triagebot/transfer.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Issue Transfer
2+
3+
The `transfer` command allows you to transfer a GitHub issue from one repository to another.
4+
5+
## Usage
6+
7+
To transfer an issue to another repository, enter a comment with the form:
8+
9+
`@rustbot transfer` *repository-name*
10+
11+
It is recommended to also include a comment explaining why you are transferring. For example:
12+
13+
```
14+
Transferring to rust-lang/cargo since this is an issue with how cargo
15+
implements diagnostic reports.
16+
17+
@rustbot transfer cargo
18+
```
19+
20+
**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.
21+
22+
**WARNING:** Transferring is a partially destructive command. For example, labels and milestones that don't exist in the target repository will be removed.
23+
24+
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.
25+
26+
## Configuration
27+
28+
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.
29+
30+
```toml
31+
[transfer]
32+
```
33+
34+
## Implementation
35+
36+
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).

0 commit comments

Comments
 (0)