element-hq / element-hq/synapse

tie lint output into github annotations

Open
#10,622 0 comments 0 reactions 0 assignees View on GitHub
P3 T-Task
Dominant language
Python
Stars
4.6k
Forks
600
Avg merge
5d 22h
Merged PRs (30d)
51

Description

This issue has been migrated from [#10622](https://github.com/matrix-org/synapse/issues/10622).

---

In github actions, it's possible to define some regexes which get matched against the script output, and allow individual lines in the PR to be annotated accordingly. It would be nice to do this for our linters.

See https://github.com/actions/toolkit/blob/master/docs/problem-matchers.md, and https://github.com/TrueBrain/actions-flake8/blob/main/action/flake8-matcher.json for an example

Contributor guide

Open the contributing guide

Research direction

Start with the GitHub Actions problem matchers documentation and the linked TrueBrain flake8 matcher example, then inspect Synapse's lint workflows to identify where linter output is emitted. Done means lint failures produce matching inline annotations on pull-request lines; verify the workflows with a representative lint failure.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.