From 41031470cf916820aad51bb4a95745ffeecf493a Mon Sep 17 00:00:00 2001 From: Louis Elkner-Alfaro Date: Fri, 25 Oct 2024 09:56:47 -0700 Subject: [PATCH] Add warnings to readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index de2eea8..6e4a7d9 100644 --- a/README.md +++ b/README.md @@ -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.