GitHub action to create an issue containing a list of project cards according with the project column name specified.
| input | required | default | description |
|---|---|---|---|
| columns | yes | Project column names separated by comma. | |
| project-beta-number | yes | Project beta number. | |
| organization | yes | Organization name. | |
| template | no | "{{title}} {{#if assignees }} by {{assignees}} {{/if}} {{#if number}} in [#{{number}}]({{url}}) {{/if}}" |
Handlebar template to generate markdown. |
The output of this action is an new issue containing all cards given the project column.
You have two ways to configure this action.
You need to create a GitHub application under your organization with the following permissions:
pull-requests: readissues: read/write
members: readprojects: read
Copy the Private key and App id from the application created.
Go to your repository and create two secrets:
GH_APP_PRIVATE_KEYGH_APP_ID
Install the application in your organization. This is necessary to generate the token that grants permissions to perform the actions.
Workflow configured with Github app tokens:
name: changelog
on:
workflow_dispatch:
jobs:
run:
runs-on: ubuntu-latest
permissions:
contents: write
organization: read
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version-file: '.nvmrc'
- name: Generate token
id: generate_token
uses: tibdex/github-app-token@v1
with:
app_id: ${{ secrets.GH_APP_ID }}
private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}
- name: Creating an issue action
uses: nearform-actions/github-action-project-changelog@v1
id: changelog
with:
columns: #todo, in progress
organization: #fake organization
project-beta-number: #1
env:
GH_TOKEN: ${{ steps.generate_token.outputs.token }}You can also configure this action by creating a PAT with the following permissions:
repo: alladmin:org -> read:org
Create the following secret in your repository
GH_CHANGELOG_PAT
Workflow configured with your PAT:
name: changelog
on:
workflow_dispatch:
jobs:
run:
runs-on: ubuntu-latest
permissions:
contents: write
organization: read
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version-file: '.nvmrc'
- name: Creating an issue action
uses: nearform-actions/github-action-project-changelog@v1
id: changelog
with:
columns: #todo, in progress
organization: #fake organization
project-beta-number: #1
env:
GH_TOKEN: ${{ secrets.GH_CHANGELOG_PAT }}Configure the workflow:
name: changelog
on:
workflow_dispatch:
jobs:
run:
runs-on: ubuntu-latest
permissions:
contents: write
organization: read
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version-file: '.nvmrc'
- name: Generate token
id: generate_token
uses: tibdex/github-app-token@v1
with:
app_id: ${{ secrets.GH_APP_ID }}
private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}
- name: Creating an issue action
uses: nearform-actions/github-action-project-changelog@v1
id: changelog
with:
columns: #todo, in progress
organization: #fake organization
project-beta-number: #1
env:
GH_TOKEN: ${{ steps.generate_token.outputs.token }}You can also specify a template input written in handlebars to be used to create a card list in markdown.
The following properties can be used to define a template:
url: issue url or pull request urlassignees: card assigneesnumber: issue number or pull request numbertitle: card title
Example:
name: changelog
on:
workflow_dispatch:
jobs:
run:
runs-on: ubuntu-latest
permissions:
contents: write
organization: read
steps:
...
- name: Creating an issue action
uses: nearform-actions/github-action-project-changelog@v1
id: changelog
with:
columns: #todo, in progress
organization: #fake organization
project-beta-number: #1
template: "{{title}} {{#if assignees }} by {{assignees}} {{/if}} {{#if number}} in [#{{number}}]({{url}}) {{/if}}"
env:
GH_TOKEN: ${{ steps.generate_token.outputs.token }}As alternative you can configure the workflow to get all inputs dynamically.
Example to get columns dynamically:
name: changelog
on:
workflow_dispatch:
inputs:
columns:
type: string
description: 'Project beta columns'
required: true
jobs:
run:
runs-on: ubuntu-latest
permissions:
contents: write
organization: read
steps:
...
- name: Creating an issue action
uses: nearform-actions/github-action-project-changelog@v1
id: changelog
with:
organization: # organization name
project-beta-number: #project beta number
columns: ${{ github.event.inputs.columns }}
env:
GH_TOKEN: ${{ steps.generate_token.outputs.token }}![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![optic-release-automation[bot] avatar](https://avatars.githubusercontent.com/u/1544687?v=4 "optic-release-automation[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent