https://github.com/quansight-labs/hackmd-meeting-notes-action
An experiment with Github Actions and HackMD
https://github.com/quansight-labs/hackmd-meeting-notes-action
Last synced: 28 days ago
JSON representation
An experiment with Github Actions and HackMD
- Host: GitHub
- URL: https://github.com/quansight-labs/hackmd-meeting-notes-action
- Owner: Quansight-Labs
- License: bsd-3-clause
- Created: 2023-01-10T21:43:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-12T15:50:13.000Z (4 months ago)
- Last Synced: 2025-06-12T16:51:10.345Z (4 months ago)
- Size: 45.9 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hackmd-meeting-notes-action
An experiment with Github Actions and HackMD.
It contains two reusable workflows:
- [Create](.github/workflows/create-meeting-notes-pr.yml): Opens a PR with a rendered version of your meeting notes template and pushes a copy to your HackMD team.
- [Sync](.github/workflows/sync-meeting-notes-pr.yml): Updates the PR document with the latest contents in HackMD.
You will need to [issue a HackMD team token](https://hackmd.io/@hackmd-api/how-to-issue-an-api-token) and store it as a secret.
Check the `inputs` and `secrets` fields in the `workflow_call` trigger for the [Create](.github/workflows/create-meeting-notes-pr.yml) and [Sync](.github/workflows/sync-meeting-notes-pr.yml)
workflows for more details.
## Setup
You need to create a workflow out of the two actions here: Create and Sync.
In this example:
- The Create workflow is triggered manually via `workflow_dispatch`, but you could have it on a cronjob as well.
- The Sync workflow is triggered by adding a label to the PR, but you could use a PR comment trigger with some authentication, if you want.
See `.github/workflows/use-action.yml` for more details.
## How to use this example
1. Go to "Actions> Create PR for meeting notes" and run a `workflow_dispatch` job.
2. A PR will be created containing the link to the freshly created HackMD document.
3. Edit the HackMD document as much as you want.
4. When you are done, go back to the PR and add the `sync-hackmd-notes` label.
5. Merge!