Repository files navigation

🤖 Automate GitHub Project cards with any webhook event

This action allows you to use any of thepull_request andissue webhook events to automate your project cards. For example when anissue isopened create a card in the Backlog project, Triage column.

If thepull_request orissue card already exists it will be moved to the column provided. Otherwise the card will be created in the column.

Create aproject with columns in your repository, user profile or organisation.

Create a new workflow.yml file in the.github/workflows/ directory. In the.ymlfile you have to decide what webhook events going move or create a card in a column. For more detailed explanation of the workflow file, check out theGitHub documentation. See the examples below to get started quickly.

Move opened issues into the Triage column of the Backlog project

name:Move new issues into Triageon:issues:types:[opened]jobs:automate-project-columns:runs-on:ubuntu-lateststeps:      -uses:alex-page/github-project-automation-plus@v0.8.3with:project:Backlogcolumn:Triagerepo-token:${{ secrets.GITHUB_TOKEN }}

Add assigned pull requests into the To Do column of the Backlog project

name:Move assigned pull requests into To doon:pull_request:types:[assigned]jobs:automate-project-columns:runs-on:ubuntu-lateststeps:      -uses:alex-page/github-project-automation-plus@v0.8.3with:project:Backlogcolumn:To dorepo-token:${{ secrets.GITHUB_TOKEN }}

Change these options in the workflow.yml file to meet your GitHub project needs.

Most of the timeGITHUB_TOKEN will work as yourrepo-token. This requires no set up. If you have a public project board and public repository this is the option for you.

Repository project, private repository or organisation projects

You will need a personal access token to send events from your issues and pull requests.

1. Create a personal access token

   1. Public repository and repository project
   2. Private repository or private project
   3. Organisation project board or organisation repository

2. Add a secretGHPROJECT_TOKEN with the personal access token.

3. Update therepo-token in the workflow.yml to reference your new token name:

repo-token:${{ secrets.GHPROJECT_TOKEN }}

GraphqlError: Resource not accessible by integration orSecrets are not currently available to forks.

This error happens on repository projects and forked repositories becauseGITHUB_TOKEN only has read permissions. Create a personal access token following the instructions above.

Parameter token or opts.auth is required

This error happens when using a personal access token to run the workflow on PRs from forked repositories. This is becauseGitHub secrets are not populated for workflows triggered by forks. Usepull_request_target as the webhook event instead toenable access to secrets.

SAML enforcement

With certain organisations there may be SAML enforcement. This means you will need toEnable SSO when you create the personal access token.

GraphqlError: Resource protected by organization SAML enforcement. You must grant your personal token access to this organization

Can't read repository null

Make sure your permissions for your personal access token are correctly configured. Follow the aboveguide on permissions.

Private repositories

You may need to enable policy settings to allow running workflows from forks. Please refer to GitHub's documentation to learn about enabling these settings atenterprise,organization, orrepository level.

• v0.8.3 - Update documentation so users get latest version
• v0.8.2 - Update NodeJS support to use latest version
• v0.8.1 - Fixissue_coment error with automation
• v0.8.0 - Add new action typeadd
• v0.7.1 - Move Node.js version back to v12
• v0.7.0 - Update documentation and dependencies
• v0.6.0 - Add support forpull_request_target andpull_request_review
• v0.5.1 - Fix get event data fromissue_coment
• v0.5.0 - Add option todelete card
• v0.4.0 - Addissue_comment event
• v0.3.0 - Addpull_request_target event
• v0.2.4 - Update dependencies
• v0.2.3 - Replace reserved secretGITHUB_TOKEN withGITHUB_TOKEN in documentation
• v0.2.2 - Refactor add and move card logic ✨
• v0.2.1 - Fix bug with move logic when card is already in project
• v0.2.0 - Restructure project, add tests, change add and move logic
• v0.1.3 - Exact match for project names
• v0.1.2 - Fix action not running for a card that exists in multiple projects
• v0.1.1 - Document type filter so action runs once
• v0.1.0 - Add support for user projects
• v0.0.3 - Automatic build before commit
• v0.0.2 - Error handling using GitHub actions
• v0.0.1 - Update icon and color for GitHub actions
• v0.0.0 - Initial release