Skip to content

Commit

Permalink
docs: rename workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
kudoas committed Oct 20, 2023
1 parent 03be2b2 commit 070d297
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Sync Issue
# Sync Issue Field

This action automatically synchronizes child and parent issue information.
If you create child issue from parent issue, the parent information is copied to the child.
This action automatically synchronizes child and parent issue field.
If you create child issue from parent issue, the parent field is copied to the child.

# Usage

<!-- start usage -->

```yaml
with:
# Repository name with owner. For example, kudoas/gis
# Repository name with owner. For example, kudoas/sync-issue-field
# Default: ${{ github.repository }}
repository: ""

Expand All @@ -18,6 +18,7 @@ with:
issue: ""

# Personal access token (PAT) used to fetch the repository.
# If you want to get an Item from Project v2, please issue PAT.
token: ""
```
Expand All @@ -28,7 +29,7 @@ with:
Create a [workflow](https://docs.github.com/en/actions/using-workflows) and save it as a `.yml` file in the `.github/workflows/` directory of your target repository.

```yml
name: Sync issue
name: Sync issue field
on:
issues:
types: [opened]
Expand All @@ -42,9 +43,8 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@main
- name: Sync issue
uses: kudoas/sync-issue@main
- name: Sync issue field
uses: kudoas/sync-issue-field@main
with:
token: ${{ secrets.GITHUB_TOKEN }}
```
Expand Down

0 comments on commit 070d297

Please sign in to comment.