Announcement Drafter

A 🤖  for drafting and publishing new GitHub discussions using pull requests.

Do you use GitHub discussions? Do you create announcements for your open-source projects or team posts? How do you get feedback or peer reviews on your post before creating it?

Now you can:

    1️⃣  Create a pull request to get feedback from your teammates on your announcement
    2️⃣  Merge the pull request to have your announcement posted!

You can even use private repos to draft announcements and get feedback privately, and on merge have the announcement created in your public repo.

No more copy/pasting your post content into Google Docs. No more rewriting the markdown. Write the markdown once, get feedback and merge 🚀

Quickstart Guide

1. Install the GitHub App and authorize it for any repositories or orgs you would like it to watch or post to.

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

   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

   watch_folders:
     - docs/discussions/

3. Now whenever you create a pull request with discussion markdown in those watch folders, announcement-drafter will ask for approvals to create the discussion

4. When the pull request is merged, it will create the discussion as the pull request author!

Discussion Markdown

announcement-drafter needs to know certain information such as what repository or team to create the discussion in, and what the discussion category should be. This information should be provided in YAML metadata at the top of your markdown file.

Draft a Repository Discussion

<!--
repository: https://github.com/philip-gai/announcement-drafter-demo
category: announcements
-->

<!-- This is the discussion title -->
# Hello World! 👋

Hello beautiful world! 🌎

Draft a Team Post

<!--
team: https://github.com/orgs/elastico-group/teams/everyone
-->

<!-- This is the post title -->
# Hello World! 👋

Hello beautiful world! 🌎