mirror of
https://github.com/hernikplays/freelo-action.git
synced 2024-11-12 19:48:07 +01:00
docs: update docs
This commit is contained in:
parent
d0a6afe3ed
commit
ac2825a020
2 changed files with 15 additions and 0 deletions
|
@ -24,6 +24,7 @@ Please note that **contributing to this project means agreeing to the Developer
|
|||
|
||||
<summary>Developer Certificate of Origin text</summary>
|
||||
|
||||
```
|
||||
Developer Certificate of Origin
|
||||
Version 1.1
|
||||
|
||||
|
@ -58,6 +59,7 @@ By making a contribution to this project, I certify that:
|
|||
personal information I submit with it, including my sign-off) is
|
||||
maintained indefinitely and may be redistributed consistent with
|
||||
this project or the open source license(s) involved.
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
|
|
13
README.md
13
README.md
|
@ -1,6 +1,9 @@
|
|||
# Freelo Synchronization GitHub action
|
||||
This action can be used for a one-way synchronization of GitHub issues into [Freelo](https://freelo.io)
|
||||
|
||||
It will log in as a Freelo user and create tasks/subtasks from created issues. Depending on the set up, it can
|
||||
also update it based on edits made on GitHub (see below).
|
||||
|
||||
## How to use
|
||||
Example action.yml showcasing all supported `on` calls:
|
||||
|
||||
|
@ -33,6 +36,16 @@ jobs:
|
|||
> It's okay to omit some of the `on` listening types, but it is needed to keep the `issue.opened` type,
|
||||
> because it creates the task and the comment to track the task across action runs.
|
||||
|
||||
### Parameters
|
||||
| Parameter | Description | Required |
|
||||
|--------------|--------------------------------------------------------------------------------------------------|-----------------------------|
|
||||
| email | E-mail used to log into Freelo; will be the author of all tasks/comments created by this action! | Yes |
|
||||
| api-key | API key to authenticate the user | Yes |
|
||||
| project-id | ID of the project where tasks will be created | Yes |
|
||||
| github-token | GitHub token used to create issue comments; you should use the default `secrets.GITHUB_TOKEN` | Yes |
|
||||
| task-id | ID of the task under which subtasks will be created from issues | If `tasklist-id` is not set |
|
||||
| tasklist-id | ID of the tasklist where tasks will be created from issues | If `task-id` is not set |
|
||||
|
||||
### Linking GitHub users to Freelo users
|
||||
The action will look for a `freelo.txt` file inside of your `.github` folder (the one where Action workflows are stored).
|
||||
In it you can map GitHub usernames to Freelo IDs, one user per line:
|
||||
|
|
Loading…
Reference in a new issue