Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

hughrun
Copy link
Contributor

@hughrun hughrun commented Apr 28, 2024

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.

…e 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 has been transferred to `bookwyrm-social`. A new private key should be generated, and the `APPLICATION_ID` and `APPLICATION_PRIVATE_KEY` 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 added a commit to hughrun/documentation that referenced this pull request Apr 28, 2024
This is a sibling commit for bookwyrm-social/bookwyrm#3363

These add 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.

1. In order to work, the related PR in the main repository will also need to be merged, as it triggers the job here, and the Bot set up as described in the PR in the main repository.
@hughrun hughrun marked this pull request as ready for review April 28, 2024 04:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant