You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-13Lines changed: 15 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,13 +23,13 @@ Check it out and don't forget to ⭐ !
23
23
24
24
## Demo
25
25
26
-

26
+
<!-- -->
27
27
28
28
Demo repo: [announcement-drafter demo]
29
29
30
30
## Quickstart Guide
31
31
32
-
1.[Install the GitHub App](https://github.com/apps/announcement-drafter) and authorize for any repositories or teams you would like it to be able to post to or watch for markdown posts.
32
+
1.[Install the GitHub App](https://github.com/apps/announcement-drafter) and authorize it for any repositories or orgs you would like it to watch or post to.
33
33
2. Add a `.github/announcement-drafter.yml` (not `.yaml`) configuration file to any repositories you want the bot to watch. [Look here for an example in the demo repo][announcement-drafter demo config]
34
34
35
35
1. Provide what folders you want the `announcement-drafter` bot to watch and (optionally) what folders you would like it to ignore when new pull requests are open
3. Now whenever you create a pull request with discussion markdown in those watch folders, `announcement-drafter` will ask for approvals to create discussions, and when the pull request is merged, it will create the discussions and post as the pull request author!
43
-
4. See [Usage](#usage) for more specific usage instructions
42
+
3. Now whenever you create a pull request with [discussion markdown](#discussion-markdown) in those watch folders, `announcement-drafter` will ask for approvals to create the discussion
43
+
4. When the pull request is merged, it will create the discussion *as the pull request author*!
44
+
5. See [Usage](#usage) for more specific usage instructions
44
45
45
46
## Usage
46
47
@@ -72,7 +73,7 @@ watch_folders:
72
73
73
74
#### Examples
74
75
75
-
See the [demo repository](https://github.com/philip-gai/announcement-drafter-demo/blob/main/docs/demo) for more.
76
+
See the [demo repository](**https**://github.com/philip-gai/announcement-drafter-demo/blob/main/docs/demo) for more.
76
77
77
78
##### Draft a Repository Discussion
78
79
@@ -110,21 +111,22 @@ Hello beautiful world! 🌎
110
111
| `repository` | The full url to the repository to create the discussion in<br/>**Prerequisites:**<br/> 1. Discussions are enabled<br/> 2. The app is installed on the repo | **Conditional**: Required if no `team` is provided | `https://github.com/philip-gai/announcement-drafter-demo` |
111
112
| `team` | The full url to the team to create the discussion in<br/>**Prerequisites:**<br/> 1. The app is installed on the team organization | **Conditional**: Required if no `repository` is provided | `https://github.com/orgs/elastico-group/teams/everyone` |
112
113
| `category` | The name of the discussion category | **Conditional**: Required if `repository` is provided | `announcements` |
113
-
| Discussion Title | The title of your discussion should be the first top-level header (i.e. `# Discussion Title`) | Yes | See [Example](#example) |
114
-
| Discussion Body | The body of your discussion is everything after the top-level header | Yes | See [Example](#example) |
114
+
| Discussion Title | The title of your discussion should be the first top-level header (i.e. `# Discussion Title`) | Yes | See [Example](#examples) |
115
+
| Discussion Body | The body of your discussion is everything after the top-level header | Yes | See [Example](#examples) |
115
116
116
117
### Workflow for reviewing and posting a new discussion
117
118
118
-
1. Write your discussion post with with `announcement-drafter` [discussion markdown](#discussion-markdown)
119
+
1. Write your discussion post as usual, adding a special [header with metadata](#discussion-markdown)
119
120
1. Create a pull request
120
-
1. `announcement-drafter` will comment on the discussion markdown file asking for approval from the pull request author to post the discussions. It will also notify you of any validation erros.
121
-
1. If there are errors, just fix them and push to the pull request branch and `announcement-drafter` will revalidate
121
+
1. `announcement-drafter` will comment on the file asking for approval from the pull request author to post the discussion
122
+
1. If there are errors, just fix them and push to the pull request branch and `announcement-drafter` will [automatically revalidate](https://github.com/philip-gai/announcement-drafter/discussions/75)
122
123
1. Receive feedback from your teammates
123
-
1. Make updates
124
-
1. Approve all the discussions you would like posted by reacting (not replying) with a 🚀
124
+
1. Push updates
125
125
1. If `announcement-drafter` bot asks, make sure to authenticate so it can post as the author and not as itself
126
+
1. Approve the discussion to be created by reacting (not replying) with a 🚀
126
127
1. Merge the pull request
127
-
1. `announcement-drafter` will create the discussion and reply to the comment with a link to the newly created discussion
128
+
1. `announcement-drafter` will create the discussion
129
+
1. `announcement-drafter` will reply to the comment with a link to the newly created discussion
0 commit comments