Question 1

How do I configure create-issue-branch to skip branch creation for certain labels?

Accepted Answer

In your issue-branch.yml, add a branches entry with the label and skip: true. For example, to skip for 'question' labels, use: branches: - label: question skip: true. This prevents automatic branch creation when those labels are present.

Question 2

Create issue branch vs GitHub's native create branch button: which is better?

Accepted Answer

Create Issue Branch offers advanced automation like label-based rules, automatic PRs, and Conventional Commits, while GitHub's button is simpler but limited to basic branch creation. Choose Create Issue Branch for customized workflows; use GitHub's button for minimal, manual setups.

Question 3

Can create-issue-branch work with private repositories?

Accepted Answer

Yes, but for private organization repositories, a paid plan is required when using the GitHub App from the Marketplace. The GitHub Action version can be used freely with the GITHUB_TOKEN secret, but ensure proper permissions are set.

Question 4

How to set up chatops mode with create-issue-branch?

Accepted Answer

Configure mode: chatops in issue-branch.yml and ensure the issue_comment event is triggered in your workflow. Then, comment /cib on an issue to create a branch. You can customize the command or enable experimental features for branch name arguments.

Question 5

Does create-issue-branch support automatic issue closing when a PR is merged?

Accepted Answer

Yes, enable autoCloseIssue: true in the configuration. The app needs to find the issue number in the branch name, so ensure your branch naming includes it, such as with the default 'full' format or a custom template starting with the issue number.

Question 6

How to add Conventional Commit prefixes to PR titles?

Accepted Answer

Set conventionalPrTitles: true in issue-branch.yml. You can customize the style (semver, semver-no-gitmoji, gitmoji) and labels via conventionalLabels. This automatically prefixes PR titles based on issue or PR labels for semantic versioning.

Question 7

What happens if the configuration YAML has errors?

Accepted Answer

The app creates an issue titled 'Error in Create Issue Branch app configuration' in the repository to alert users. Subsequent runs with invalid configs won't create new issues, so you need to fix the YAML based on the initial error message.

Create Issue Branch

What is Create Issue Branch?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions