Skip to content

Repository files navigation

create-pr

A bash script that helps create your PRs. It normalizes the PR title, description, assignee by default, and initial label based on your branch name.

Current support

These are needed to access your client via the terminal, and they are independent of this script.

Extra arguments

Any additional argument will be passed to gh or glab tool.

# Create a draft PR
./create-pr --draft
# Create a draft PR with an overridden title
./create-pr --draft --title="Custom Title"

Installation

You can download the latest single executable script on the Releases page or build it yourself.

If you download the executable file from a release's GitHub project, you can check the file's checksum to validate that it was not altered. The checksum for each release is on each release on GitHub.

To build the project yourself, execute the script ./build.sh and move the resulting bin/create-pr script wherever you want.

How to use it?

The script is customizable via .env variables. See .env.example.

PR_TEMPLATE_PATH

Define the path to locate the PR template. See template example.

Example

PR_TEMPLATE_PATH=.github/PULL_REQUEST_TEMPLATE.md

Placeholders

  • {{ TICKET_LINK }}
    • Uses PR_TICKET_LINK_PREFIX appending the ticket key and number to form the full URL
  • {{ BACKGROUND }}
    • if the link is found: Details in the ticket
    • if the link is not found: Provide some context to the reviewer before jumping in the code
  • You can define them inside a comment (to avoid rendering the placeholders when creating a PR without this script)
    • eg <!-- {{ TICKET_LINK }} -->

PR_LINK_PREFIX_TEXT

Text to display if the link does not contain a TICKET_KEY.

Example

Branch name: feat/27-my-branch-name

PR_TICKET_LINK_PREFIX="https://github.com/Chemaclass/create-pr/issues/"
PR_LINK_PREFIX_TEXT="Closes: "
  • Result: Closes: https://github.com/Chemaclass/create-pr/issues/27

PR_TITLE_TEMPLATE

Enable custom PR title with placeholders:

  • {{TICKET_NUMBER}}
  • {{TICKET_KEY}}
  • {{PR_TITLE}}

Example

PR_TITLE_TEMPLATE="{{TICKET_KEY}}-{{TICKET_NUMBER}} {{PR_TITLE}}"

PR_TITLE_REMOVE_PREFIX

Remove custom prefix text from the generated title. Useful when you have tickets prefixed with some text like BE: or FE:.

Example

By default, having a branch named: feat/ticket-123-be-crete-feature-foo

Default behaviour:

  • TICKET-123 Be create feature foo

With PR_TITLE_REMOVE_PREFIX=be the result will be:

  • TICKET-123 Create feature foo

This variable accept multiple strings to consider/remove comma separated.

Eg: PR_TITLE_REMOVE_PREFIX=be,fe

PR_LABEL

Alias: LABEL

Define a label for the PR.

Example

PR_LABEL=enhancement

If empty, extract the label from the branch's prefix - see PR_LABEL_MAPPING.

PR_LABEL_MAPPING

Define a mapping from prefix branches to GitHub label.

Example

PR_LABEL_MAPPING="docs:documentation; fix|bug|bugfix|hotfix:bug; default:enhancement"
  • eg docs/your-branch -> documentation label
  • eg fix/your-branch -> bug label
  • eg bug/your-branch -> bug label
  • eg unknown/your-branch -> enhancement label

PR_ASSIGNEE

Alias: ASSIGNEE

  • PR_ASSIGNEE or @me by default

PR_REVIEWER

Alias: REVIEWER

  • Empty by default

TARGET_BRANCH

  • TARGET_BRANCH or main by default

PR_RUN_AFTER_CREATION

Run a custom command automatically after the PR is successfully created. This is useful for automated post-creation tasks like updating the PR description, running additional validations, or triggering notifications.

Example

PR_RUN_AFTER_CREATION="claude -p 'using gh update the current PR in this branch description following the template, keep it simple'"

The command has access to all environment variables like CURRENT_BRANCH, TARGET_BRANCH, etc.

Note: If the script fails, a warning is displayed but the PR creation is still considered successful.

HINTS

  • Add to your composer, npm or similar a script pointing to the create-pr
  • You can use the PULL_REQUEST_TEMPLATE from this project as example

Contribute

Suggestions, ideas and PRs are more than welcome here! Please, Check out our CONTRIBUTING.md guidelines.

About

A bash script to create PR based on your branch and context.

Topics

Resources

Code of conduct

Contributing

Stars

14 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - Chemaclass/create-pr: A bash script to create PR based on your branch and context. · GitHub
Skip to content

Repository files navigation

create-pr

A bash script that helps create your PRs. It normalizes the PR title, description, assignee by default, and initial label based on your branch name.

Current support

These are needed to access your client via the terminal, and they are independent of this script.

Extra arguments

Any additional argument will be passed to gh or glab tool.

# Create a draft PR
./create-pr --draft
# Create a draft PR with an overridden title
./create-pr --draft --title="Custom Title"

Installation

You can download the latest single executable script on the Releases page or build it yourself.

If you download the executable file from a release's GitHub project, you can check the file's checksum to validate that it was not altered. The checksum for each release is on each release on GitHub.

To build the project yourself, execute the script ./build.sh and move the resulting bin/create-pr script wherever you want.

How to use it?

The script is customizable via .env variables. See .env.example.

PR_TEMPLATE_PATH

Define the path to locate the PR template. See template example.

Example

PR_TEMPLATE_PATH=.github/PULL_REQUEST_TEMPLATE.md

Placeholders

  • {{ TICKET_LINK }}
    • Uses PR_TICKET_LINK_PREFIX appending the ticket key and number to form the full URL
  • {{ BACKGROUND }}
    • if the link is found: Details in the ticket
    • if the link is not found: Provide some context to the reviewer before jumping in the code
  • You can define them inside a comment (to avoid rendering the placeholders when creating a PR without this script)
    • eg <!-- {{ TICKET_LINK }} -->

PR_LINK_PREFIX_TEXT

Text to display if the link does not contain a TICKET_KEY.

Example

Branch name: feat/27-my-branch-name

PR_TICKET_LINK_PREFIX="https://github.com/Chemaclass/create-pr/issues/"
PR_LINK_PREFIX_TEXT="Closes: "
  • Result: Closes: https://github.com/Chemaclass/create-pr/issues/27

PR_TITLE_TEMPLATE

Enable custom PR title with placeholders:

  • {{TICKET_NUMBER}}
  • {{TICKET_KEY}}
  • {{PR_TITLE}}

Example

PR_TITLE_TEMPLATE="{{TICKET_KEY}}-{{TICKET_NUMBER}} {{PR_TITLE}}"

PR_TITLE_REMOVE_PREFIX

Remove custom prefix text from the generated title. Useful when you have tickets prefixed with some text like BE: or FE:.

Example

By default, having a branch named: feat/ticket-123-be-crete-feature-foo

Default behaviour:

  • TICKET-123 Be create feature foo

With PR_TITLE_REMOVE_PREFIX=be the result will be:

  • TICKET-123 Create feature foo

This variable accept multiple strings to consider/remove comma separated.

Eg: PR_TITLE_REMOVE_PREFIX=be,fe

PR_LABEL

Alias: LABEL

Define a label for the PR.

Example

PR_LABEL=enhancement

If empty, extract the label from the branch's prefix - see PR_LABEL_MAPPING.

PR_LABEL_MAPPING

Define a mapping from prefix branches to GitHub label.

Example

PR_LABEL_MAPPING="docs:documentation; fix|bug|bugfix|hotfix:bug; default:enhancement"
  • eg docs/your-branch -> documentation label
  • eg fix/your-branch -> bug label
  • eg bug/your-branch -> bug label
  • eg unknown/your-branch -> enhancement label

PR_ASSIGNEE

Alias: ASSIGNEE

  • PR_ASSIGNEE or @me by default

PR_REVIEWER

Alias: REVIEWER

  • Empty by default

TARGET_BRANCH

  • TARGET_BRANCH or main by default

PR_RUN_AFTER_CREATION

Run a custom command automatically after the PR is successfully created. This is useful for automated post-creation tasks like updating the PR description, running additional validations, or triggering notifications.

Example

PR_RUN_AFTER_CREATION="claude -p 'using gh update the current PR in this branch description following the template, keep it simple'"

The command has access to all environment variables like CURRENT_BRANCH, TARGET_BRANCH, etc.

Note: If the script fails, a warning is displayed but the PR creation is still considered successful.

HINTS

  • Add to your composer, npm or similar a script pointing to the create-pr
  • You can use the PULL_REQUEST_TEMPLATE from this project as example

Contribute

Suggestions, ideas and PRs are more than welcome here! Please, Check out our CONTRIBUTING.md guidelines.

About

A bash script to create PR based on your branch and context.

Topics

Resources

Code of conduct

Contributing

Stars

14 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - Chemaclass/create-pr: A bash script to create PR based on your branch and context. · GitHub
Skip to content

Repository files navigation

create-pr

A bash script that helps create your PRs. It normalizes the PR title, description, assignee by default, and initial label based on your branch name.

Current support

These are needed to access your client via the terminal, and they are independent of this script.

Extra arguments

Any additional argument will be passed to gh or glab tool.

# Create a draft PR
./create-pr --draft
# Create a draft PR with an overridden title
./create-pr --draft --title="Custom Title"

Installation

You can download the latest single executable script on the Releases page or build it yourself.

If you download the executable file from a release's GitHub project, you can check the file's checksum to validate that it was not altered. The checksum for each release is on each release on GitHub.

To build the project yourself, execute the script ./build.sh and move the resulting bin/create-pr script wherever you want.

How to use it?

The script is customizable via .env variables. See .env.example.

PR_TEMPLATE_PATH

Define the path to locate the PR template. See template example.

Example

PR_TEMPLATE_PATH=.github/PULL_REQUEST_TEMPLATE.md

Placeholders

  • {{ TICKET_LINK }}
    • Uses PR_TICKET_LINK_PREFIX appending the ticket key and number to form the full URL
  • {{ BACKGROUND }}
    • if the link is found: Details in the ticket
    • if the link is not found: Provide some context to the reviewer before jumping in the code
  • You can define them inside a comment (to avoid rendering the placeholders when creating a PR without this script)
    • eg <!-- {{ TICKET_LINK }} -->

PR_LINK_PREFIX_TEXT

Text to display if the link does not contain a TICKET_KEY.

Example

Branch name: feat/27-my-branch-name

PR_TICKET_LINK_PREFIX="https://github.com/Chemaclass/create-pr/issues/"
PR_LINK_PREFIX_TEXT="Closes: "
  • Result: Closes: https://github.com/Chemaclass/create-pr/issues/27

PR_TITLE_TEMPLATE

Enable custom PR title with placeholders:

  • {{TICKET_NUMBER}}
  • {{TICKET_KEY}}
  • {{PR_TITLE}}

Example

PR_TITLE_TEMPLATE="{{TICKET_KEY}}-{{TICKET_NUMBER}} {{PR_TITLE}}"

PR_TITLE_REMOVE_PREFIX

Remove custom prefix text from the generated title. Useful when you have tickets prefixed with some text like BE: or FE:.

Example

By default, having a branch named: feat/ticket-123-be-crete-feature-foo

Default behaviour:

  • TICKET-123 Be create feature foo

With PR_TITLE_REMOVE_PREFIX=be the result will be:

  • TICKET-123 Create feature foo

This variable accept multiple strings to consider/remove comma separated.

Eg: PR_TITLE_REMOVE_PREFIX=be,fe

PR_LABEL

Alias: LABEL

Define a label for the PR.

Example

PR_LABEL=enhancement

If empty, extract the label from the branch's prefix - see PR_LABEL_MAPPING.

PR_LABEL_MAPPING

Define a mapping from prefix branches to GitHub label.

Example

PR_LABEL_MAPPING="docs:documentation; fix|bug|bugfix|hotfix:bug; default:enhancement"
  • eg docs/your-branch -> documentation label
  • eg fix/your-branch -> bug label
  • eg bug/your-branch -> bug label
  • eg unknown/your-branch -> enhancement label

PR_ASSIGNEE

Alias: ASSIGNEE

  • PR_ASSIGNEE or @me by default

PR_REVIEWER

Alias: REVIEWER

  • Empty by default

TARGET_BRANCH

  • TARGET_BRANCH or main by default

PR_RUN_AFTER_CREATION

Run a custom command automatically after the PR is successfully created. This is useful for automated post-creation tasks like updating the PR description, running additional validations, or triggering notifications.

Example

PR_RUN_AFTER_CREATION="claude -p 'using gh update the current PR in this branch description following the template, keep it simple'"

The command has access to all environment variables like CURRENT_BRANCH, TARGET_BRANCH, etc.

Note: If the script fails, a warning is displayed but the PR creation is still considered successful.

HINTS

  • Add to your composer, npm or similar a script pointing to the create-pr
  • You can use the PULL_REQUEST_TEMPLATE from this project as example

Contribute

Suggestions, ideas and PRs are more than welcome here! Please, Check out our CONTRIBUTING.md guidelines.

About

A bash script to create PR based on your branch and context.

Topics

Resources

Code of conduct

Contributing

Stars

14 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - Chemaclass/create-pr: A bash script to create PR based on your branch and context. · GitHub
Skip to content

Repository files navigation

create-pr

A bash script that helps create your PRs. It normalizes the PR title, description, assignee by default, and initial label based on your branch name.

Current support

These are needed to access your client via the terminal, and they are independent of this script.

Extra arguments

Any additional argument will be passed to gh or glab tool.

# Create a draft PR
./create-pr --draft
# Create a draft PR with an overridden title
./create-pr --draft --title="Custom Title"

Installation

You can download the latest single executable script on the Releases page or build it yourself.

If you download the executable file from a release's GitHub project, you can check the file's checksum to validate that it was not altered. The checksum for each release is on each release on GitHub.

To build the project yourself, execute the script ./build.sh and move the resulting bin/create-pr script wherever you want.

How to use it?

The script is customizable via .env variables. See .env.example.

PR_TEMPLATE_PATH

Define the path to locate the PR template. See template example.

Example

PR_TEMPLATE_PATH=.github/PULL_REQUEST_TEMPLATE.md

Placeholders

  • {{ TICKET_LINK }}
    • Uses PR_TICKET_LINK_PREFIX appending the ticket key and number to form the full URL
  • {{ BACKGROUND }}
    • if the link is found: Details in the ticket
    • if the link is not found: Provide some context to the reviewer before jumping in the code
  • You can define them inside a comment (to avoid rendering the placeholders when creating a PR without this script)
    • eg <!-- {{ TICKET_LINK }} -->

PR_LINK_PREFIX_TEXT

Text to display if the link does not contain a TICKET_KEY.

Example

Branch name: feat/27-my-branch-name

PR_TICKET_LINK_PREFIX="https://github.com/Chemaclass/create-pr/issues/"
PR_LINK_PREFIX_TEXT="Closes: "
  • Result: Closes: https://github.com/Chemaclass/create-pr/issues/27

PR_TITLE_TEMPLATE

Enable custom PR title with placeholders:

  • {{TICKET_NUMBER}}
  • {{TICKET_KEY}}
  • {{PR_TITLE}}

Example

PR_TITLE_TEMPLATE="{{TICKET_KEY}}-{{TICKET_NUMBER}} {{PR_TITLE}}"

PR_TITLE_REMOVE_PREFIX

Remove custom prefix text from the generated title. Useful when you have tickets prefixed with some text like BE: or FE:.

Example

By default, having a branch named: feat/ticket-123-be-crete-feature-foo

Default behaviour:

  • TICKET-123 Be create feature foo

With PR_TITLE_REMOVE_PREFIX=be the result will be:

  • TICKET-123 Create feature foo

This variable accept multiple strings to consider/remove comma separated.

Eg: PR_TITLE_REMOVE_PREFIX=be,fe

PR_LABEL

Alias: LABEL

Define a label for the PR.

Example

PR_LABEL=enhancement

If empty, extract the label from the branch's prefix - see PR_LABEL_MAPPING.

PR_LABEL_MAPPING

Define a mapping from prefix branches to GitHub label.

Example

PR_LABEL_MAPPING="docs:documentation; fix|bug|bugfix|hotfix:bug; default:enhancement"
  • eg docs/your-branch -> documentation label
  • eg fix/your-branch -> bug label
  • eg bug/your-branch -> bug label
  • eg unknown/your-branch -> enhancement label

PR_ASSIGNEE

Alias: ASSIGNEE

  • PR_ASSIGNEE or @me by default

PR_REVIEWER

Alias: REVIEWER

  • Empty by default

TARGET_BRANCH

  • TARGET_BRANCH or main by default

PR_RUN_AFTER_CREATION

Run a custom command automatically after the PR is successfully created. This is useful for automated post-creation tasks like updating the PR description, running additional validations, or triggering notifications.

Example

PR_RUN_AFTER_CREATION="claude -p 'using gh update the current PR in this branch description following the template, keep it simple'"

The command has access to all environment variables like CURRENT_BRANCH, TARGET_BRANCH, etc.

Note: If the script fails, a warning is displayed but the PR creation is still considered successful.

HINTS

  • Add to your composer, npm or similar a script pointing to the create-pr
  • You can use the PULL_REQUEST_TEMPLATE from this project as example

Contribute

Suggestions, ideas and PRs are more than welcome here! Please, Check out our CONTRIBUTING.md guidelines.

About

A bash script to create PR based on your branch and context.

Topics

Resources

Code of conduct

Contributing

Stars

14 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' GitHub - Chemaclass/create-pr: A bash script to create PR based on your branch and context. · GitHub
Skip to content

Repository files navigation

create-pr

A bash script that helps create your PRs. It normalizes the PR title, description, assignee by default, and initial label based on your branch name.

Current support

These are needed to access your client via the terminal, and they are independent of this script.

Extra arguments

Any additional argument will be passed to gh or glab tool.

# Create a draft PR
./create-pr --draft
# Create a draft PR with an overridden title
./create-pr --draft --title="Custom Title"

Installation

You can download the latest single executable script on the Releases page or build it yourself.

If you download the executable file from a release's GitHub project, you can check the file's checksum to validate that it was not altered. The checksum for each release is on each release on GitHub.

To build the project yourself, execute the script ./build.sh and move the resulting bin/create-pr script wherever you want.

How to use it?

The script is customizable via .env variables. See .env.example.

PR_TEMPLATE_PATH

Define the path to locate the PR template. See template example.

Example

PR_TEMPLATE_PATH=.github/PULL_REQUEST_TEMPLATE.md

Placeholders

  • {{ TICKET_LINK }}
    • Uses PR_TICKET_LINK_PREFIX appending the ticket key and number to form the full URL
  • {{ BACKGROUND }}
    • if the link is found: Details in the ticket
    • if the link is not found: Provide some context to the reviewer before jumping in the code
  • You can define them inside a comment (to avoid rendering the placeholders when creating a PR without this script)
    • eg <!-- {{ TICKET_LINK }} -->

PR_LINK_PREFIX_TEXT

Text to display if the link does not contain a TICKET_KEY.

Example

Branch name: feat/27-my-branch-name

PR_TICKET_LINK_PREFIX="https://github.com/Chemaclass/create-pr/issues/"
PR_LINK_PREFIX_TEXT="Closes: "
  • Result: Closes: https://github.com/Chemaclass/create-pr/issues/27

PR_TITLE_TEMPLATE

Enable custom PR title with placeholders:

  • {{TICKET_NUMBER}}
  • {{TICKET_KEY}}
  • {{PR_TITLE}}

Example

PR_TITLE_TEMPLATE="{{TICKET_KEY}}-{{TICKET_NUMBER}} {{PR_TITLE}}"

PR_TITLE_REMOVE_PREFIX

Remove custom prefix text from the generated title. Useful when you have tickets prefixed with some text like BE: or FE:.

Example

By default, having a branch named: feat/ticket-123-be-crete-feature-foo

Default behaviour:

  • TICKET-123 Be create feature foo

With PR_TITLE_REMOVE_PREFIX=be the result will be:

  • TICKET-123 Create feature foo

This variable accept multiple strings to consider/remove comma separated.

Eg: PR_TITLE_REMOVE_PREFIX=be,fe

PR_LABEL

Alias: LABEL

Define a label for the PR.

Example

PR_LABEL=enhancement

If empty, extract the label from the branch's prefix - see PR_LABEL_MAPPING.

PR_LABEL_MAPPING

Define a mapping from prefix branches to GitHub label.

Example

PR_LABEL_MAPPING="docs:documentation; fix|bug|bugfix|hotfix:bug; default:enhancement"
  • eg docs/your-branch -> documentation label
  • eg fix/your-branch -> bug label
  • eg bug/your-branch -> bug label
  • eg unknown/your-branch -> enhancement label

PR_ASSIGNEE

Alias: ASSIGNEE

  • PR_ASSIGNEE or @me by default

PR_REVIEWER

Alias: REVIEWER

  • Empty by default

TARGET_BRANCH

  • TARGET_BRANCH or main by default

PR_RUN_AFTER_CREATION

Run a custom command automatically after the PR is successfully created. This is useful for automated post-creation tasks like updating the PR description, running additional validations, or triggering notifications.

Example

PR_RUN_AFTER_CREATION="claude -p 'using gh update the current PR in this branch description following the template, keep it simple'"

The command has access to all environment variables like CURRENT_BRANCH, TARGET_BRANCH, etc.

Note: If the script fails, a warning is displayed but the PR creation is still considered successful.

HINTS

  • Add to your composer, npm or similar a script pointing to the create-pr
  • You can use the PULL_REQUEST_TEMPLATE from this project as example

Contribute

Suggestions, ideas and PRs are more than welcome here! Please, Check out our CONTRIBUTING.md guidelines.

About

A bash script to create PR based on your branch and context.

Topics

Resources

Code of conduct

Contributing

Stars

14 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - Chemaclass/create-pr: A bash script to create PR based on your branch and context. · GitHub
Skip to content

Repository files navigation

create-pr

A bash script that helps create your PRs. It normalizes the PR title, description, assignee by default, and initial label based on your branch name.

Current support

These are needed to access your client via the terminal, and they are independent of this script.

Extra arguments

Any additional argument will be passed to gh or glab tool.

# Create a draft PR
./create-pr --draft
# Create a draft PR with an overridden title
./create-pr --draft --title="Custom Title"

Installation

You can download the latest single executable script on the Releases page or build it yourself.

If you download the executable file from a release's GitHub project, you can check the file's checksum to validate that it was not altered. The checksum for each release is on each release on GitHub.

To build the project yourself, execute the script ./build.sh and move the resulting bin/create-pr script wherever you want.

How to use it?

The script is customizable via .env variables. See .env.example.

PR_TEMPLATE_PATH

Define the path to locate the PR template. See template example.

Example

PR_TEMPLATE_PATH=.github/PULL_REQUEST_TEMPLATE.md

Placeholders

  • {{ TICKET_LINK }}
    • Uses PR_TICKET_LINK_PREFIX appending the ticket key and number to form the full URL
  • {{ BACKGROUND }}
    • if the link is found: Details in the ticket
    • if the link is not found: Provide some context to the reviewer before jumping in the code
  • You can define them inside a comment (to avoid rendering the placeholders when creating a PR without this script)
    • eg <!-- {{ TICKET_LINK }} -->

PR_LINK_PREFIX_TEXT

Text to display if the link does not contain a TICKET_KEY.

Example

Branch name: feat/27-my-branch-name

PR_TICKET_LINK_PREFIX="https://github.com/Chemaclass/create-pr/issues/"
PR_LINK_PREFIX_TEXT="Closes: "
  • Result: Closes: https://github.com/Chemaclass/create-pr/issues/27

PR_TITLE_TEMPLATE

Enable custom PR title with placeholders:

  • {{TICKET_NUMBER}}
  • {{TICKET_KEY}}
  • {{PR_TITLE}}

Example

PR_TITLE_TEMPLATE="{{TICKET_KEY}}-{{TICKET_NUMBER}} {{PR_TITLE}}"

PR_TITLE_REMOVE_PREFIX

Remove custom prefix text from the generated title. Useful when you have tickets prefixed with some text like BE: or FE:.

Example

By default, having a branch named: feat/ticket-123-be-crete-feature-foo

Default behaviour:

  • TICKET-123 Be create feature foo

With PR_TITLE_REMOVE_PREFIX=be the result will be:

  • TICKET-123 Create feature foo

This variable accept multiple strings to consider/remove comma separated.

Eg: PR_TITLE_REMOVE_PREFIX=be,fe

PR_LABEL

Alias: LABEL

Define a label for the PR.

Example

PR_LABEL=enhancement

If empty, extract the label from the branch's prefix - see PR_LABEL_MAPPING.

PR_LABEL_MAPPING

Define a mapping from prefix branches to GitHub label.

Example

PR_LABEL_MAPPING="docs:documentation; fix|bug|bugfix|hotfix:bug; default:enhancement"
  • eg docs/your-branch -> documentation label
  • eg fix/your-branch -> bug label
  • eg bug/your-branch -> bug label
  • eg unknown/your-branch -> enhancement label

PR_ASSIGNEE

Alias: ASSIGNEE

  • PR_ASSIGNEE or @me by default

PR_REVIEWER

Alias: REVIEWER

  • Empty by default

TARGET_BRANCH

  • TARGET_BRANCH or main by default

PR_RUN_AFTER_CREATION

Run a custom command automatically after the PR is successfully created. This is useful for automated post-creation tasks like updating the PR description, running additional validations, or triggering notifications.

Example

PR_RUN_AFTER_CREATION="claude -p 'using gh update the current PR in this branch description following the template, keep it simple'"

The command has access to all environment variables like CURRENT_BRANCH, TARGET_BRANCH, etc.

Note: If the script fails, a warning is displayed but the PR creation is still considered successful.

HINTS

  • Add to your composer, npm or similar a script pointing to the create-pr
  • You can use the PULL_REQUEST_TEMPLATE from this project as example

Contribute

Suggestions, ideas and PRs are more than welcome here! Please, Check out our CONTRIBUTING.md guidelines.

About

A bash script to create PR based on your branch and context.

Topics

Resources

Code of conduct

Contributing

Stars

14 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - Chemaclass/create-pr: A bash script to create PR based on your branch and context. · GitHub
Skip to content

Repository files navigation

create-pr

A bash script that helps create your PRs. It normalizes the PR title, description, assignee by default, and initial label based on your branch name.

Current support

These are needed to access your client via the terminal, and they are independent of this script.

Extra arguments

Any additional argument will be passed to gh or glab tool.

# Create a draft PR
./create-pr --draft
# Create a draft PR with an overridden title
./create-pr --draft --title="Custom Title"

Installation

You can download the latest single executable script on the Releases page or build it yourself.

If you download the executable file from a release's GitHub project, you can check the file's checksum to validate that it was not altered. The checksum for each release is on each release on GitHub.

To build the project yourself, execute the script ./build.sh and move the resulting bin/create-pr script wherever you want.

How to use it?

The script is customizable via .env variables. See .env.example.

PR_TEMPLATE_PATH

Define the path to locate the PR template. See template example.

Example

PR_TEMPLATE_PATH=.github/PULL_REQUEST_TEMPLATE.md

Placeholders

  • {{ TICKET_LINK }}
    • Uses PR_TICKET_LINK_PREFIX appending the ticket key and number to form the full URL
  • {{ BACKGROUND }}
    • if the link is found: Details in the ticket
    • if the link is not found: Provide some context to the reviewer before jumping in the code
  • You can define them inside a comment (to avoid rendering the placeholders when creating a PR without this script)
    • eg <!-- {{ TICKET_LINK }} -->

PR_LINK_PREFIX_TEXT

Text to display if the link does not contain a TICKET_KEY.

Example

Branch name: feat/27-my-branch-name

PR_TICKET_LINK_PREFIX="https://github.com/Chemaclass/create-pr/issues/"
PR_LINK_PREFIX_TEXT="Closes: "
  • Result: Closes: https://github.com/Chemaclass/create-pr/issues/27

PR_TITLE_TEMPLATE

Enable custom PR title with placeholders:

  • {{TICKET_NUMBER}}
  • {{TICKET_KEY}}
  • {{PR_TITLE}}

Example

PR_TITLE_TEMPLATE="{{TICKET_KEY}}-{{TICKET_NUMBER}} {{PR_TITLE}}"

PR_TITLE_REMOVE_PREFIX

Remove custom prefix text from the generated title. Useful when you have tickets prefixed with some text like BE: or FE:.

Example

By default, having a branch named: feat/ticket-123-be-crete-feature-foo

Default behaviour:

  • TICKET-123 Be create feature foo

With PR_TITLE_REMOVE_PREFIX=be the result will be:

  • TICKET-123 Create feature foo

This variable accept multiple strings to consider/remove comma separated.

Eg: PR_TITLE_REMOVE_PREFIX=be,fe

PR_LABEL

Alias: LABEL

Define a label for the PR.

Example

PR_LABEL=enhancement

If empty, extract the label from the branch's prefix - see PR_LABEL_MAPPING.

PR_LABEL_MAPPING

Define a mapping from prefix branches to GitHub label.

Example

PR_LABEL_MAPPING="docs:documentation; fix|bug|bugfix|hotfix:bug; default:enhancement"
  • eg docs/your-branch -> documentation label
  • eg fix/your-branch -> bug label
  • eg bug/your-branch -> bug label
  • eg unknown/your-branch -> enhancement label

PR_ASSIGNEE

Alias: ASSIGNEE

  • PR_ASSIGNEE or @me by default

PR_REVIEWER

Alias: REVIEWER

  • Empty by default

TARGET_BRANCH

  • TARGET_BRANCH or main by default

PR_RUN_AFTER_CREATION

Run a custom command automatically after the PR is successfully created. This is useful for automated post-creation tasks like updating the PR description, running additional validations, or triggering notifications.

Example

PR_RUN_AFTER_CREATION="claude -p 'using gh update the current PR in this branch description following the template, keep it simple'"

The command has access to all environment variables like CURRENT_BRANCH, TARGET_BRANCH, etc.

Note: If the script fails, a warning is displayed but the PR creation is still considered successful.

HINTS

  • Add to your composer, npm or similar a script pointing to the create-pr
  • You can use the PULL_REQUEST_TEMPLATE from this project as example

Contribute

Suggestions, ideas and PRs are more than welcome here! Please, Check out our CONTRIBUTING.md guidelines.

About

A bash script to create PR based on your branch and context.

Topics

Resources

Code of conduct

Contributing

Stars

14 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); GitHub - Chemaclass/create-pr: A bash script to create PR based on your branch and context. · GitHub
Skip to content

Repository files navigation

create-pr

A bash script that helps create your PRs. It normalizes the PR title, description, assignee by default, and initial label based on your branch name.

Current support

These are needed to access your client via the terminal, and they are independent of this script.

Extra arguments

Any additional argument will be passed to gh or glab tool.

# Create a draft PR
./create-pr --draft
# Create a draft PR with an overridden title
./create-pr --draft --title="Custom Title"

Installation

You can download the latest single executable script on the Releases page or build it yourself.

If you download the executable file from a release's GitHub project, you can check the file's checksum to validate that it was not altered. The checksum for each release is on each release on GitHub.

To build the project yourself, execute the script ./build.sh and move the resulting bin/create-pr script wherever you want.

How to use it?

The script is customizable via .env variables. See .env.example.

PR_TEMPLATE_PATH

Define the path to locate the PR template. See template example.

Example

PR_TEMPLATE_PATH=.github/PULL_REQUEST_TEMPLATE.md

Placeholders

  • {{ TICKET_LINK }}
    • Uses PR_TICKET_LINK_PREFIX appending the ticket key and number to form the full URL
  • {{ BACKGROUND }}
    • if the link is found: Details in the ticket
    • if the link is not found: Provide some context to the reviewer before jumping in the code
  • You can define them inside a comment (to avoid rendering the placeholders when creating a PR without this script)
    • eg <!-- {{ TICKET_LINK }} -->

PR_LINK_PREFIX_TEXT

Text to display if the link does not contain a TICKET_KEY.

Example

Branch name: feat/27-my-branch-name

PR_TICKET_LINK_PREFIX="https://github.com/Chemaclass/create-pr/issues/"
PR_LINK_PREFIX_TEXT="Closes: "
  • Result: Closes: https://github.com/Chemaclass/create-pr/issues/27

PR_TITLE_TEMPLATE

Enable custom PR title with placeholders:

  • {{TICKET_NUMBER}}
  • {{TICKET_KEY}}
  • {{PR_TITLE}}

Example

PR_TITLE_TEMPLATE="{{TICKET_KEY}}-{{TICKET_NUMBER}} {{PR_TITLE}}"

PR_TITLE_REMOVE_PREFIX

Remove custom prefix text from the generated title. Useful when you have tickets prefixed with some text like BE: or FE:.

Example

By default, having a branch named: feat/ticket-123-be-crete-feature-foo

Default behaviour:

  • TICKET-123 Be create feature foo

With PR_TITLE_REMOVE_PREFIX=be the result will be:

  • TICKET-123 Create feature foo

This variable accept multiple strings to consider/remove comma separated.

Eg: PR_TITLE_REMOVE_PREFIX=be,fe

PR_LABEL

Alias: LABEL

Define a label for the PR.

Example

PR_LABEL=enhancement

If empty, extract the label from the branch's prefix - see PR_LABEL_MAPPING.

PR_LABEL_MAPPING

Define a mapping from prefix branches to GitHub label.

Example

PR_LABEL_MAPPING="docs:documentation; fix|bug|bugfix|hotfix:bug; default:enhancement"
  • eg docs/your-branch -> documentation label
  • eg fix/your-branch -> bug label
  • eg bug/your-branch -> bug label
  • eg unknown/your-branch -> enhancement label

PR_ASSIGNEE

Alias: ASSIGNEE

  • PR_ASSIGNEE or @me by default

PR_REVIEWER

Alias: REVIEWER

  • Empty by default

TARGET_BRANCH

  • TARGET_BRANCH or main by default

PR_RUN_AFTER_CREATION

Run a custom command automatically after the PR is successfully created. This is useful for automated post-creation tasks like updating the PR description, running additional validations, or triggering notifications.

Example

PR_RUN_AFTER_CREATION="claude -p 'using gh update the current PR in this branch description following the template, keep it simple'"

The command has access to all environment variables like CURRENT_BRANCH, TARGET_BRANCH, etc.

Note: If the script fails, a warning is displayed but the PR creation is still considered successful.

HINTS

  • Add to your composer, npm or similar a script pointing to the create-pr
  • You can use the PULL_REQUEST_TEMPLATE from this project as example

Contribute

Suggestions, ideas and PRs are more than welcome here! Please, Check out our CONTRIBUTING.md guidelines.

About

A bash script to create PR based on your branch and context.

Topics

Resources

Code of conduct

Contributing

Stars

14 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages