Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alex-page/add-new-pulls-project

✨ GitHub action to magically add new pull requests to projects
https://github.com/alex-page/add-new-pulls-project

github-actions github-projects pull-requests

Last synced: about 2 months ago
JSON representation

✨ GitHub action to magically add new pull requests to projects

Awesome Lists containing this project

README

        

# ‼️This is no longer supported ‼️

Please use [`GitHub Project Automation+`](https://github.com/marketplace/actions/github-project-automation) instead. The following snippet adds all new pull requests to a project column using GitHub Project Automation+:

```yml
name: Automate project columns

on: [pull_request]

jobs:
automate-project-columns:
runs-on: ubuntu-latest
steps:
- name: Move new pull requests into Triage
if: github.event_name == 'pull_request' && github.event.action == 'opened'
uses: alex-page/automate-project-columns@master
with:
project: Backlog
column: Triage
repo-token: ${{ secrets.GITHUB_TOKEN }}
```

---

# Add new pull requests to project

> ✨ GitHub action to automagically add new pull requests to projects.

## How to use

To use this action we need the project name and the name of the column for the new pull requests will go into. The project and column names will be used to get a column ID for automation.

In your project create a new workflow file `.github/main.workflow`:
```
workflow "✨Add new pull requests to projects" {
resolves = ["alex-page/add-new-pulls-project"]
on = "pull_request"
}

action "alex-page/add-new-pulls-project" {
uses = "alex-page/add-new-pulls-project@master"
args = [ "🎒 Backlog", "To do"]
secrets = ["GITHUB_TOKEN"]
}
```

> Note: Replace `🎒 Backlog` with your project name and `To do` with your project column.

## Private repositories

In some cases you may want to do add this functionality for a private repository or one you do not have admin rights to. You will likely get an error like:
```shell
GraphqlError: Resource not accessible by integration
```

When this happens you will need to provide a [personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line). To do this you will need to create a new secret called `GH_PAT` with your secret. You will then need to change the `.github/main.workflow` secrets to include that token:
```
secrets = ["GH_PAT"]
```

## Release history

- v0.0.5 - Deprecated
- v0.0.4 - Fix incorrect documentation
- v0.0.3 - Add optional personal access token for private repos
- v0.0.2 - End in a neutral state for unsupported pull request action
- v0.0.1 - First release