From ac2825a020c88141252a374fb8b87e3eb1e94dcd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maty=C3=A1=C5=A1=20Caras?= Date: Tue, 30 Jul 2024 19:26:32 +0200 Subject: [PATCH] docs: update docs --- CONTRIBUTING.md | 2 ++ README.md | 13 +++++++++++++ 2 files changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index edf0a05..a75897b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,7 @@ Please note that **contributing to this project means agreeing to the Developer Developer Certificate of Origin text +``` 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. +``` diff --git a/README.md b/README.md index 0d9f966..f357120 100644 --- a/README.md +++ b/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: