github / github/gh-stack

`gh stack submit` does not respect org-wide PR template

Open
#492 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
1.5k
Forks
70
Avg merge
1d 8h
Merged PRs (30d)
7

Description

My organisation has an org-wide PR template, just as the one described here: https://github.com/orgs/community/discussions/183776. We used to have these templates in each repo, but they were all the same and repetitve, so we decided to define them in one place. We'd rather not go back to per-repo template.

Unfortunately, `gh stack submit` does not seem to respect them. User has two options with this command:
* By default it opens CLI dialog to enter PR's title and description. It doesn't use the org template
* `--auto` creates PR with some pre-populated footer and nothing else. Again no template is used.

The command supports repo-wide templates, thanks to https://github.com/github/gh-stack/pull/77, but this PR does not seem to take org-wide templates into account.

Contributor guide

Open the contributing guide

Research direction

Start by tracing the `gh stack submit` entry point and its default dialog and `--auto` paths, using github/gh-stack pull request #77 as context for repo-wide templates. Reproduce both modes with an organization-wide PR template, then verify that the resulting pull request includes that template without losing the existing footer.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, go
Domain
api, cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.