swiftlang / swiftlang/github-workflows

Add support for emitting github action annotations for soundness checks

Open
#88 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
115
Forks
57
Avg merge
1d 8h
Merged PRs (30d)
3

Description

It would be awesome if soundness checks emitted code-level annotations via workflow commands in PRs. Last I used them, it was as simple as echo-ing a special syntax to indicate file, line, and column information.

Namely, this could be useful for:

  • header checks
  • format/lint checks
  • acceptable language checks

(It would be extra cool if this also worked for failing tests, but that might be a tad more involved).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the soundness checks for headers, format/lint, and acceptable-language checks, then review the linked GitHub Actions workflow-command syntax. Determine where each check reports file, line, and column information. Done means applicable failures emit GitHub annotations in pull requests; annotations for failing tests are explicitly treated as extra scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.