canonical / canonical/data-platform-workflows

Log to GitHub annotations instead of stdout

Open
#27 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
8
Forks
17
Avg merge
1d 11h
Merged PRs (30d)
3

Description

Annotations example:
![annotations](https://github.com/actions/toolkit/raw/main/docs/assets/annotations.png)

`logger.debug`, `logger.warning`, and `logger.error`/`logger.exception` should create annotations using workflow commands

Workflow commands docs:
https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#using-workflow-commands-to-access-toolkit-functions
https://github.com/actions/toolkit/blob/main/docs/commands.md

Also log output can be grouped to improve readability: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#grouping-log-lines

Contributor guide

Open the contributing guide

Research direction

Locate the logger.debug, logger.warning, logger.error, and logger.exception implementations in the repository, then read the linked GitHub Actions workflow-command documentation. Done means these log methods create GitHub annotations instead of only writing to stdout, with log output grouped where appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.