search

bookwyrm-social / bookwyrm

Social reading and reviewing, decentralized with ActivityPub
http://joinbookwyrm.com/
Other
2.17k stars 255 forks source link

auto-create new issue in documentation repo when `needs-docs` label in PR #3363

Closed hughrun closed 3 weeks ago

hughrun commented 2 months ago

This commit adds one of a pair of GitHub Actions to create a new issue in the documentation repository when a PR with a needs-docs label is merged in the main repository. This is intended to support improved documentation.

Additional steps required

  1. In order to work, the related PR in the documentation repository will also need to be merged, as it contains a job that actually creates the issue. The action in this repository simply triggers an alert and passes information to the other repository.

  2. I have created a GitHub bot with the sole purpose of enabling the use of authorisation tokens with tightly-scoped permissions owned by the organization rather than an individual. We need this because we're triggering an action in one repository to do trigger another action in a different repository. Ownership will be transferred to bookwyrm-social assuming this PR is welcomed. A new private key needs to be generated, and the APPLICATION_ID and APPLICATION_PRIVATE_KEY (i.e.the key just generated) need to be added to the main repository's Action SECRETS. Both repositories (or "All repositories") must be granted access, in the Bot configuration screen.

  3. In the main repository settings, Actions - General permissions must be set to Allow all actions and reusable workflows.

hughrun commented 3 weeks ago

On reflection this is unnecessarily over-complicating things. We can just keep an eye on PRs and release notes.