feat: add support for custom pr template path

README.md

@@ -18,17 +18,17 @@ A GitHub (`gh`) CLI extension to automate the daily work with **branches**, **co
 
 2. Checking out an automatically generated branch based on an issue id:
 
-    ```sh
-    gh prx checkout-new 1234 # Where 1234 is the issue's key. If not provided, a list of issues will be prompted.
-    ```
+   ```sh
+   gh prx checkout-new 1234 # Where 1234 is the issue's key. If not provided, a list of issues will be prompted.
+   ```
 
    <img src="https://github.com/ilaif/gh-prx/raw/main/assets/gh-prx-checkout-new-issue.gif" width="700">
 
 3. Creating a new PR with automatically generated title/body and checklist prompt:
 
-    ```sh
-    gh prx create
-    ```
+   ```sh
+   gh prx create
+   ```
 
    <img src="https://github.com/ilaif/gh-prx/raw/main/assets/gh-prx-create.gif" width="700">
 
@@ -44,16 +44,16 @@ Many of us find the terminal and CLI applications as our main toolkit.
 
 ## Features
 
-* Automatically creating new branches named based on issues fetched from project management tools
-  * Currently supported: GitHub, Jira, Linear
-* Extended PR creation:
-  * Automatically push branch to origin
-  * Parse branch names by a pattern into a customized PR title and description template
-  * Add labels based on issue types
-  * Filter commits and display them in the PR description
-  * Interactively answer PR checklists before creating the PR
-  * Use AI (🔮) to summarize the PR's changes
-  * All `gh pr create` original flags are extended into the tool
+- Automatically creating new branches named based on issues fetched from project management tools
+  - Currently supported: GitHub, Jira, Linear
+- Extended PR creation:
+  - Automatically push branch to origin
+  - Parse branch names by a pattern into a customized PR title and description template
+  - Add labels based on issue types
+  - Filter commits and display them in the PR description
+  - Interactively answer PR checklists before creating the PR
+  - Use AI (🔮) to summarize the PR's changes
+  - All `gh pr create` original flags are extended into the tool
 
 > `gh-prx` is an early-stage project. Got a new feature in mind? Open a pull request or a [feature request](https://github.com/ilaif/gh-prx/issues/new) 🙏
 
@@ -82,6 +82,7 @@ pr:
 issue:
    provider: github # The provider to use for fetching issue details (supported: github,jira,linear)
    types: ["fix", "feat", "chore", "docs", "refactor", "test", "style", "build", "ci", "perf", "revert"] # The issue types to prompt the user when creating a new branch
+   pull_request_template_path: "./pull_request_template.md" # The pull request template file to use when creating a new PR. Relative to the .gh-prx.yaml file location.
    ignore_pull_request_template: false # If true, the pull request template in the repository will be ignored.
 checkout_new:
    jira:
@@ -96,24 +97,25 @@ checkout_new:
 
 The PR description is based on the repo's `.github/pull_request_template.md`. If this file does not exist, a default template is used:
 
-   ```markdown
-   {{with .Issue}}Closes #{{.}}.
+```markdown
+{{with .Issue}}Closes #{{.}}.
 
-   {{end}}## Description
+{{end}}## Description
 
-   {{if .AISummary}}{{.AISummary}}{{ else }}{{humanize .Description}}
+{{if .AISummary}}{{.AISummary}}{{ else }}{{humanize .Description}}
 
-   Change(s) in this PR:
-   {{range $commit := .Commits}}
-   * {{$commit}}
-   {{- end}}
-   {{- end}}
+Change(s) in this PR:
+{{range $commit := .Commits}}
 
-   ## PR Checklist
+- {{$commit}}
+  {{- end}}
+  {{- end}}
 
-   - [ ] Tests are included
-   - [ ] Documentation is changed or added
-   ```
+## PR Checklist
+
+- [ ] Tests are included
+- [ ] Documentation is changed or added
+```
 
 ## Templating
 
@@ -129,13 +131,13 @@ Example:
 
 Given:
 
-* `token_separators: ["-"]`
-* `{{.Description}}`: "my-dashed-string"
-* Template:
+- `token_separators: ["-"]`
+- `{{.Description}}`: "my-dashed-string"
+- Template:
 
-   ```go-template
-   This is "{{ humanize .Description}}"
-   ```
+  ```go-template
+  This is "{{ humanize .Description}}"
+  ```
 
 Result:
 
@@ -157,11 +159,11 @@ Upper cases a string.
 
 ### Special template variable names
 
-* `{{.Type}}` - Used to interpret GitHub labels to add to the PR and issue type to add the branch name.
-* `{{.Issue}}` - Used as a placeholder for the issue key when creating a new branch.
-* `{{.Description}}` - Used as a placeholder for the issue title when creating a new branch.
-* `{{.Commits}}` - Used as a placeholder in a PR description (body) to iterate over filtered commits.
-* `{{.AISummary}}` - Used as a placeholder in a PR description (body) to add a summary of the PR's changes based on AI.
+- `{{.Type}}` - Used to interpret GitHub labels to add to the PR and issue type to add the branch name.
+- `{{.Issue}}` - Used as a placeholder for the issue key when creating a new branch.
+- `{{.Description}}` - Used as a placeholder for the issue title when creating a new branch.
+- `{{.Commits}}` - Used as a placeholder in a PR description (body) to iterate over filtered commits.
+- `{{.AISummary}}` - Used as a placeholder in a PR description (body) to add a summary of the PR's changes based on AI.
 
 ## AI summary configuration
 

pkg/cmd/create.go

@@ -147,7 +147,13 @@ func create(ctx context.Context, opts *CreateOpts) error {
 		baseBranch = strings.Trim(stdOut.String(), "\n")
 	}
 
-	if cfg.IgnorePullRequestTemplate == nil || !*cfg.IgnorePullRequestTemplate {
+	if cfg.PullRequestTemplatePath != "" {
+		prTemplateBytes, err := utils.ReadFile(cfg.PullRequestTemplatePath)
+		if err != nil {
+			return errors.Wrap(err, "Failed to read pull request template")
+		}
+		cfg.PR.Body = string(prTemplateBytes)
+	} else if cfg.IgnorePullRequestTemplate == nil || !*cfg.IgnorePullRequestTemplate {
 		prTemplateBytes, err := utils.ReadFile(".github/pull_request_template.md")
 		if err == nil {
 			cfg.PR.Body = string(prTemplateBytes)

pkg/config/repository_config.go

@@ -60,6 +60,7 @@ type RepositoryConfig struct {
 	Branch                    BranchConfig      `yaml:"branch"`
 	PR                        PullRequestConfig `yaml:"pr"`
 	Issue                     IssueConfig       `yaml:"issue"`
+	PullRequestTemplatePath   string            `yaml:"pull_request_template_path"`
 	IgnorePullRequestTemplate *bool             `yaml:"ignore_pull_request_template"`
 	CheckoutNew               CheckoutNewConfig `yaml:"checkout_new"`
 }