realm / realm/SwiftLint

Jazzy errors are not being detected in CI

Open
#5,690 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discussion documentation
Dominant language
Swift
Stars
19.7k
Forks
2.3k
Avg merge
1d 1h
Merged PRs (30d)
11

Description

New Issue Checklist
Describe the bug

A clear and concise description of what the bug is.

It looks like Jazzy warnings and errors are not being detected in CI. For example, https://dev.azure.com/jpsim/SwiftLint/_build/results?buildId=8942&view=logs&j=ca898bab-e9ac-5909-e869-07ade246060d&t=bdc59b0b-f79d-5892-08f4-c67ba9c29a9a

Examples which are in a sense separate issues, but I'm just recording it all here for right now.

The first issue I noticed (because I was wondering where the reporters documentation was) is:

WARNING: No documented top-level declarations match name "CSVReporter" specified in categories file
WARNING: No documented top-level declarations match name "CheckstyleReporter" specified in categories file
WARNING: No documented top-level declarations match name "CodeClimateReporter" specified in categories file
WARNING: No documented top-level declarations match name "EmojiReporter" specified in categories file
WARNING: No documented top-level declarations match name "GitHubActionsLoggingReporter" specified in categories file
WARNING: No documented top-level declarations match name "HTMLReporter" specified in categories file
WARNING: No documented top-level declarations match name "JSONReporter" specified in categories file
WARNING: No documented top-level declarations match name "JUnitReporter" specified in categories file
WARNING: No documented top-level declarations match name "MarkdownReporter" specified in categories file

I think the problem here is that the reporters are not public anymore since https://github.com/realm/SwiftLint/commit/5544ce1d476ccc366ffabe0612b21fd355ec93f6

Other warnings, which are not so obviously warnings:

Parsing ViolationsSyntaxVisitor.swift (108/108)
Found conflicting type declarations with the same name, which may indicate a build issue or a bug in Jazzy: instance method init(fromAny:context:), instance method init(fromAny:context:)
Found conflicting type declarations with the same name, which may indicate a build issue or a bug in Jazzy: instance method asOption(), instance method asOption()
Found conflicting type declarations with the same name, which may indicate a build issue or a bug in Jazzy: instance method asDescription(with:), instance method asDescription(with:)
Found conflicting type declarations with the same name, which may indicate a build issue or a bug in Jazzy: instance method apply(_:ruleID:), instance method apply(_:ruleID:)
Found conflicting type declarations with the same name, which may indicate a build issue or a bug in Jazzy: instance method kind(from:), instance method kind(from:), instance method kind(from:), instance method kind(from:)
Found conflicting type declarations with the same name, which may indicate a build issue or a bug in Jazzy: instance method collectInfo(for:), instance method collectInfo(for:)
Found conflicting type declarations with the same name, which may indicate a build issue or a bug in Jazzy: instance method validate(file:collectedInfo:), instance method validate(file:collectedInfo:)
Found conflicting type declarations with the same name, which may indicate a build issue or a bug in Jazzy: instance method validate(file:), instance method validate(file:)
Found conflicting type declarations with the same name, which may indicate a build issue or a bug in Jazzy: instance method makeViolation(file:violation:), instance method makeViolation(file:violation:)

and

Parsing Glob.swift (39/108)
/Users/runner/work/1/s/Source/SwiftLintCore/Helpers/Glob.swift:8:8: error: no such module 'Glibc'
import Glibc
       ^

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 with the linked Azure CI build log and compare the Jazzy reporter warnings with the documentation configuration. Review the reporter declarations affected by commit 5544ce1d476ccc366ffabe0612b21fd355ec93f6 and the Glibc error in Source/SwiftLintCore/Helpers/Glob.swift. Done means Jazzy warnings and errors are detected reliably in CI.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
ci-cd, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.