Add workflow to publish release notes directly to discourse #7860
Conversation
| DISCOURSE_URL: "https://discourse.pymc.io" | ||
| DISCOURSE_CATEGORY: "Development" | ||
| RELEASE_TAG: ${{ github.event.release.tag_name }} | ||
| RELEASE_BODY: ${{ github.event.release.body }} |
There was a problem hiding this comment.
Not sure if I need to escape to json or not
There was a problem hiding this comment.
Pull Request Overview
This PR adds automation to publish GitHub release notes directly to a Discourse forum. The implementation includes a Python script that fetches release information from GitHub and posts it as a formatted topic to Discourse using their API.
Key changes:
- Python script for publishing release notes to Discourse with error handling and content formatting
- GitHub Actions workflow triggered on release publication
- Configuration updates to allow print statements in the script
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| scripts/publish_release_notes_to_discourse.py | Main script that handles Discourse API communication and content formatting |
| .github/workflows/publish-release-notes-to-discourse.yml | GitHub Actions workflow to trigger the script on release events |
| pyproject.toml | Linting configuration update to allow print statements in the new script |
| url = f"{config['DISCOURSE_URL']}/posts.json" | ||
|
|
||
| try: | ||
| response = requests.post(url, headers=headers, data=topic_data) |
There was a problem hiding this comment.
The request should use 'json=topic_data' instead of 'data=topic_data' since the headers specify 'Content-Type: application/json' but this parameter sends form-encoded data.
| response = requests.post(url, headers=headers, data=topic_data) | |
| response = requests.post(url, headers=headers, json=topic_data) |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
data seemed to work fine, but this is something I'm still not sure about, also on how to pass from the workflow to script. Rather test and see how it goes
| headers = {"Api-Key": config["DISCOURSE_API_KEY"], "Api-Username": config["DISCOURSE_USERNAME"]} | ||
| url = f"{config['DISCOURSE_URL']}/posts.json" | ||
|
|
||
| try: | ||
| response = requests.post(url, headers=headers, data=topic_data) |
There was a problem hiding this comment.
The headers for the POST request are missing 'Content-Type: application/json' which is included in the GET request headers and is necessary when sending JSON data.
| headers = {"Api-Key": config["DISCOURSE_API_KEY"], "Api-Username": config["DISCOURSE_USERNAME"]} | |
| url = f"{config['DISCOURSE_URL']}/posts.json" | |
| try: | |
| response = requests.post(url, headers=headers, data=topic_data) | |
| headers = { | |
| "Api-Key": config["DISCOURSE_API_KEY"], | |
| "Api-Username": config["DISCOURSE_USERNAME"], | |
| "Content-Type": "application/json", | |
| } | |
| url = f"{config['DISCOURSE_URL']}/posts.json" | |
| try: | |
| response = requests.post(url, headers=headers, json=topic_data) |
Copilot uses AI. Check for mistakes.
31727a9 to
d56efbe
Compare
| publish-to-discourse: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| persist-credentials: false | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v4 | ||
| with: | ||
| python-version: "3.11" | ||
|
|
||
| - name: Install dependencies | ||
| run: pip install requests | ||
|
|
||
| - name: Publish release to Discourse | ||
| env: | ||
| DISCOURSE_API_KEY: ${{ secrets.DISCOURSE_API_KEY }} | ||
| DISCOURSE_USERNAME: "pymc-bot" | ||
| DISCOURSE_URL: "https://discourse.pymc.io" | ||
| DISCOURSE_CATEGORY: "Development" | ||
| RELEASE_TAG: ${{ github.event.release.tag_name }} | ||
| RELEASE_BODY: ${{ github.event.release.body }} | ||
| RELEASE_URL: ${{ github.event.release.html_url }} | ||
| REPO_NAME: ${{ github.repository }} |
Check warning
Code scanning / zizmor
overly broad permissions Warning
|
I suggest we merge and the next release will confirm whether the release.body output is formatting correctly or not, that's my only doubt, and I don't know a way to test locally. I've tested locally the rest. |
|
I'm a bit late to the review party, but ideally we should scope It's really simple and low-effort:
I don't have admin permissions on the PyMC repo to set this up myself. |
|
Ok I'll try it |
📚 Documentation preview 📚: https://pymc--7860.org.readthedocs.build/en/7860/