Skip to content

🥇 GitHub Project Bot fetches recently created Pull Requests (including community PRs) and updates the Project Column

Notifications You must be signed in to change notification settings

subhamX/github-project-bot

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Project Bot

Description: 🥇 GitHub Project Bot fetches recently created Pull Requests and updates the Project Column

Functionality: This GitHub action allows you to use any webhook events to automate the process of updation of project cards with recently created Pull Requests

Inputs

REPO_URL: Complete URL of Repository whose Pull Request you want to automate

PROJECT_URL: Complete URL of GitHub Project you want to use

COLUMN_NAME: Name of an existing column of the project specifed above into which you want to place pull-requests

ACCESS_TOKEN: An Access Token to create new Project Card

Organization-scope project

  1. Set the URL of Complete URL of Repository whose Pull Request you want to automate to REPO_URL
  2. Set the URL of Organization-scope project to PROJECT_URL
  3. Set the name of an existing column of the project specifed above into which you want to place pull-requests to COLUMN_NAME
  4. Use ${{ secrets.ACCESS_TOKEN }} to set the access token to ACCESS_TOKEN

Used Owned project

  1. Set the URL of Complete URL of Repository whose Pull Request you want to automate to REPO_URL
  2. Set the URL of User owned project to PROJECT_URL
  3. Set the name of an existing column of the project into which you want to place pull-requests to COLUMN_NAME
  4. Use ${{ secrets.ACCESS_TOKEN }} to set the access token to ACCESS_TOKEN

Example -

Scheduling the workflow to run at specific UTC time using cron. The following cron schedule expression will run At every 5th minute from 0 through 59 and will run the following TWO STEPS

name: Add Recently Created Pull Requests to Project Column
on:
  schedule:
    - cron: "0/5 * * * *"
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Handle Repo1
      uses: subhamX/github-project-bot@v1.0.0
      with:
        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
        COLUMN_NAME: In Progress
        PROJECT_URL: https://github.com/orgs/ORG_NAME/projects/1 
        # For User Owned Project -> PROJECT_URL: https://github.com/users/UNAME/projects/1
        REPO_URL: https://github.com/ORG_NAME/repo1
        # For User Owned Repo -> REPO_URL: https://github.com/UNAME/repo1
    - name: Handle Repo2
      uses: subhamX/github-project-bot@v1.0.0
      with:
        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
        COLUMN_NAME: In Progress
        PROJECT_URL: https://github.com/orgs/ORG_NAME/projects/1
        # For User Owned Project -> PROJECT_URL: https://github.com/users/subhamX/projects/1
        REPO_URL: https://github.com/ORG_NAME/repo2
        # For User Owned Repo -> REPO_URL: https://github.com/UNAME/repo2

About

🥇 GitHub Project Bot fetches recently created Pull Requests (including community PRs) and updates the Project Column

Topics

Resources

Stars

Watchers

Forks