litestar-org / litestar-org/project-template

ci: auto-close linked issues on PR merge

Open
#42 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ci github_actions
Dominant language
Python
Stars
13
Forks
3
PR merge metrics
No merged PRs in 30d

Description

## Context

Adopt the "PR merged" automation (from litestar-org/project-template#16): when a PR is merged, auto-close the issues it references and post a comment noting the upcoming release.

Source uses `actions/github-script` + a GraphQL query on `closingIssuesReferences`, triggered on `pull_request: closed` for `main`/`develop`.

## Proposed tasks

- [ ] Add `.github/workflows/pr-merged.yml` (github-script closing linked issues + commenting)
- [ ] Drop the `develop` branch (this repo only has `main`); simplify the minor/patch wording accordingly
- [ ] SHA-pin `actions/github-script` + least-privilege `permissions` (`issues: write`, `pull-requests: read`) to pass the zizmor gate (#22/#39)

## Notes

- GitHub already closes issues via `Closes #N` keywords on merge; this adds the **release-note comment** on top and closes issues linked via the API even when the keyword is in the PR body.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the proposed .github/workflows/pr-merged.yml and compare the referenced litestar-org/project-template#16 automation. Configure the pull_request closed trigger for main, use actions/github-script with the closingIssuesReferences query, and apply the requested SHA pinning and permissions; done means linked issues are closed and receive the release-note comment while the zizmor gate passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.