docs: add job logs section to Forgejo Actions API #9

Merged
addison merged 2 commits from exe-dev-bot/shelley-extras:docs/forgejo-job-logs into main 2026-01-30 19:11:33 -05:00
Contributor

Adds documentation and guidelines based on learnings from debugging Flutter CI:

Job Logs section:

  • Explicit warning: Do NOT use browser to check job logs
  • Correct curl command pattern
  • Clarify index_in_repo vs API id

General Guidelines additions:

  • Use automatic fixers first (e.g., dart fix --apply)
  • Use project task runners (just, make) over raw commands
  • Fix issues properly - no workarounds like CI-specific configs

Conversation Workflow:

  • Note about including project AGENTS.md updates in feature PRs

Mistakes this addresses:

  1. Used browser instead of curl for job logs
  2. Manually edited lint issues instead of using dart fix --apply
  3. Created lint-ci workaround instead of fixing actual issues
  4. Ran raw dart commands instead of using/adding just recipes
Adds documentation and guidelines based on learnings from debugging Flutter CI: **Job Logs section:** - Explicit warning: Do NOT use browser to check job logs - Correct curl command pattern - Clarify `index_in_repo` vs API `id` **General Guidelines additions:** - Use automatic fixers first (e.g., `dart fix --apply`) - Use project task runners (`just`, `make`) over raw commands - Fix issues properly - no workarounds like CI-specific configs **Conversation Workflow:** - Note about including project AGENTS.md updates in feature PRs **Mistakes this addresses:** 1. Used browser instead of curl for job logs 2. Manually edited lint issues instead of using `dart fix --apply` 3. Created `lint-ci` workaround instead of fixing actual issues 4. Ran raw `dart` commands instead of using/adding just recipes
- Add 'Getting Job Logs' section explaining the correct endpoint
- Clarify that logs use index_in_repo (web UI run number), not API id
- Note that log URLs are NOT under /api/v1/
- Update 'Debugging Failed Runs' to use correct patterns
- Add note about including project AGENTS.md updates in feature PRs

Co-authored-by: Shelley <shelley@exe.dev>
exe-dev-bot force-pushed docs/forgejo-job-logs from e4728a1937 to 6c3abaedf5 2026-01-30 19:10:16 -05:00 Compare
exe-dev-bot force-pushed docs/forgejo-job-logs from 6c3abaedf5 to cb71e71456 2026-01-30 19:10:37 -05:00 Compare
Co-authored-by: Shelley <shelley@exe.dev>
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
kwila/shelley-extras!9
No description provided.