Code Monkey home page Code Monkey logo

connect-issues-and-branches's Introduction

connect-issues-and-branches

A GitHub App built with Probot that A bot that creates workflow connections between branches and issues they are created for.

Features

Implemented

  • Whenever a branch is created for work regarding an issue, a comment will be left on the issue that links to the branch.
    • The branch name must match a specified pattern to reference the issue.
    • You may create a custom branch name pattern by following the instructions in the Configuration section.

Planned

  • If an issue is part of a project, its status should be updated to "In-Progress" when a branch is created.
  • When the branch is merged, the issue should receive an update.
    • If the issue is part of a project, its status should be updated to "Done".

Configuration

Note that you do not need to create a config file. If one is not created, it is assumed that your branch names follow the format: optional-string/#-branch-name where # is the issue number the branch is created for. If you want to create a custom branch name pattern for this bot, you must add a .github/cib-config.yml as shown below:

# Change this value to define a custom branch name pattern that will activate this bot.
branchNameRegex: "^[A-Za-z/_-]*[0-9]+[A-Za-z0-9/_-]*$"

# Change this value to define how to extract the issue number from a branch name.
# Note that the first part of the string that matches this pattern will be used as the issue number.
issueReferenceRegex: "(?<=\/)[0-9]+"

Installation

You can install directly from this page

Running your own instance

# Install dependencies
npm install

# Run typescript
npm run build

# Run the bot
npm start

Contributing

If you have suggestions for how connect-issues-and-branches could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

ISC © 2019 Sam Hirsch [email protected]

connect-issues-and-branches's People

Contributors

sam3077 avatar

Stargazers

 avatar

Watchers

 avatar  avatar

connect-issues-and-branches's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.