Add warnings to readme
This commit is contained in:
parent
fb6f226371
commit
41031470cf
1 changed files with 8 additions and 0 deletions
|
@ -11,6 +11,7 @@ We do not yet do summing of time per issue, but could with a fair amount of work
|
|||
In the meantime this can be done with a spreadsheet:
|
||||
|
||||
## Usage
|
||||
|
||||
For use with Forgejo Include your API token in .env as FORGEJO_API_TOKEN={token}
|
||||
- Token can be generated here if you do not have one: https://git.agaric.com/user/settings/applications
|
||||
|
||||
|
@ -24,3 +25,10 @@ python generate_issues.py FILE
|
|||
```
|
||||
|
||||
The program outputs to 'modified_report.csv'
|
||||
|
||||
## ⚠️ Warnings! ⚠️
|
||||
|
||||
This only parses three issues out of the harvest comment, if you have more issues in the comment it ignores them
|
||||
|
||||
Until some fundamental issues are resolved regarding error handling when failing to connect to Forgejo or if a fetched issue returns 404
|
||||
this whole thing will quit on you in an unhelpful and frustrating manner.
|
||||
|
|
Loading…
Reference in a new issue