https://github.com/korosuke613/linear-app-create-issue-action
GitHub Action to create an Issue for Linear.app.
https://github.com/korosuke613/linear-app-create-issue-action
github-action linear-app nodejs
Last synced: 8 months ago
JSON representation
GitHub Action to create an Issue for Linear.app.
- Host: GitHub
- URL: https://github.com/korosuke613/linear-app-create-issue-action
- Owner: korosuke613
- License: mit
- Created: 2021-05-16T07:13:47.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-01-05T13:35:27.000Z (over 3 years ago)
- Last Synced: 2025-02-02T08:42:07.458Z (over 1 year ago)
- Topics: github-action, linear-app, nodejs
- Language: TypeScript
- Homepage:
- Size: 1.11 MB
- Stars: 6
- Watchers: 2
- Forks: 4
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# linear-app-create-issue-action
GitHub Action to create an Issue for [Linear.app](https://linear.app/).
[](https://github.com/korosuke613/linear-app-create-issue-action/actions/workflows/ci.yml) [](https://codecov.io/gh/korosuke613/linear-app-create-issue-action)
## Usage
### Input
See [action.yml](./action.yml)
|arg|description|required|type|
|---|---|---|---|
|issueFilePath|File path of Issue markdown|yes|string|
|apiKey|api key of Linear.app ([ref](https://developers.linear.app/docs/graphql/working-with-the-graphql-api#personal-api-keys))|yes|string|
|teamId|team id of Linear.app ([ref](#faq-get-teamid-stateid))|yes|string|
|stateId|state id of Linear.app ([ref](#faq-get-teamid-stateid))|yes|string|
|isDryrun|enable dryrun (not create issue) |no|boolean|
|embed|embed variable. (ex: "month=July,day=13")|no|string|
## Usage
### Create Issue file
Create issue file in markdown format. Write the contents of [IssueCreateInput](https://github.com/linear/linear/blob/8553690da1455e2f6a109bed65223bc5400fa7c2/packages/sdk/src/schema.graphql#L2021) in YAML format on the line enclosed by ---. title is required.
If you want to change the value of YAML dynamically, you can replace `${something}` when executing the action.
[example-issue.md](./example/example-issue.md)
```markdown
---
title: Issue file example (${day}, ${month}) # title is required
estimate: 1
---
This block is description.
## Items
* Item 1
* Item 2
* Item 3
## CheckBoxes
- [ ] CheckBox 1
- [ ] CheckBox 2
*created by [korosuke613/linear-app-create-issue-action](https://github.com/korosuke613/linear-app-create-issue-action)*
```
### Create Workflow
Create a workflow `.yml` file in your repositories `.github/workflows` directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
If you want to replace ${something} in YAML, use `embed` with `key1=value1,key2=value2,...`.
[create-issue-every-friday.yml](example/create-issue-every-friday.yml)
```yaml
name: Create Issue every friday
on:
schedule:
- cron: "0 8 * * 5" # At 08:00 on Friday (UTC).
jobs:
create-issue:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: korosuke613/linear-app-create-issue-action@v1
with:
issueFilePath: "./example/example-issue.md"
apiKey: ${{ secrets.YOUR_API_TOKEN_OF_LINEAR_APP }}
teamId: ${{ secrets.YOUR_TEAM_ID_OF_LINEAR_APP }}
stateId: ${{ secrets.YOUR_STATE_ID_OF_LINEAR_APP }}
embed: month=July,day=13
```
**result**
## FAQ
### How do I get teamId and stateId?
Call the Linear API. An example is shown below.
#### teamId
input
```shell
curl \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: " \
--data '{ "query": "{ teams { nodes { id name } } }" }' \
https://api.linear.app/graphql | jq
```
output
```json
{
"data": {
"teams": {
"nodes": [
{
"id": "eeaa0cbd-xxxx-xxxx-xxxx-1c701c3485f1",
"name": "korosuke613"
}
]
}
}
}
```
#### stateId
input
```shell
curl \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: " \
--data '{ "query": "{ workflowStates { nodes { id name type } } }" }' \
https://api.linear.app/graphql | jq
```
output
```json5
{
"data": {
"workflowStates": {
"nodes": [
{
"id": "76984209-xxxx-xxxx-xxxx-78eb458a7cbe",
"name": "In Review",
"type": "started"
},
{
"id": "e788ada6-xxxx-xxxx-xxxx-5717c26104ad",
"name": "Todo",
"type": "unstarted"
},
{
"id": "c02edc3a-xxxx-xxxx-xxxx-85c349766a13",
"name": "Backlog",
"type": "backlog"
},
// etc..
]
}
}
}
```
## License
The scripts and documentation in this project are released under the [MIT License](LICENSE)