Skip to content
This repository has been archived by the owner on Jun 17, 2024. It is now read-only.

Commit

Permalink
[Trivial] Updated Readme (#3)
Browse files Browse the repository at this point in the history
* Update README.md

* Rewrite
  • Loading branch information
titoportas authored Sep 6, 2022
1 parent 642aa05 commit 421a544
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

Use this action to automatically update [GitHub project (beta)](https://docs.github.com/en/issues/trying-out-the-new-projects-experience/about-projects) item fields.
Note that this action *does not support [GitHub projects (classic)](https://docs.github.com/en/issues/organizing-your-work-with-project-boards)*.

_The main difference between this lib and others is that you can use a PAT with repo and project scopes instead of org scope._

## Usage
Expand All @@ -16,8 +17,6 @@ Once you've configured your workflow, save it as a `.yml` file in your target Re

### Example

#### Example Usage: Issue opened with labels `bug` OR `needs-triage`

```yaml
name: Create and/or Update edited issues to my project

Expand All @@ -28,7 +27,7 @@ on:

jobs:
create-update-project:
name: Add issue to project
name: Create/update project issue
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
Expand All @@ -55,7 +54,7 @@ jobs:
_See [Creating a PAT and adding it to your repository](#creating-a-pat-and-adding-it-to-your-repository) for more details_
- <a name="item-id">`item-id`</a> **(required)** project item id to be updated. Important: this id is not the issue/pull_request number.
- <a name="field-keys">`field-keys`</a> **(required)** the github project field names separated with `,`.
- <a name="field-values">`field-values`</a> **(required)** the github project field values associated to the `field-keys` separated with `,`. If the key has values with special characters (_eg: Done) you must include them.
- <a name="field-values">`field-values`</a> **(required)** the github project field values associated to the `field-keys` separated with `,`. If the key has values with special characters (_eg: Done_) you must include them.

## Creating a PAT and adding it to your repository

Expand Down Expand Up @@ -83,4 +82,4 @@ of Node (see "engines" in this action's package.json for details).
The scripts and documentation in this project are released under the [MIT License](LICENSE)

# Special mentions
I want to say thanks to the authors and contributors of [add-to-project](https://github.com/actions/add-to-project) and [project-update](https://github.com/austenstone/project-update). This Github action is based on both github projects.
I want to say thanks to the authors and contributors of [add-to-project](https://github.com/actions/add-to-project) and [project-update](https://github.com/austenstone/project-update). This Github action is based on both github projects.

0 comments on commit 421a544

Please sign in to comment.