Skip to content

chore: add CI, Makefile, linter config, etc.#2

Merged
MalteHerrmann merged 3 commits intomainfrom
setup-ci-etc
Aug 26, 2025
Merged

chore: add CI, Makefile, linter config, etc.#2
MalteHerrmann merged 3 commits intomainfrom
setup-ci-etc

Conversation

@MalteHerrmann
Copy link
Copy Markdown
Contributor

@MalteHerrmann MalteHerrmann commented Aug 26, 2025

This PR adds the usual things like CI actions, Makefile, linter configurations and other things.

Summary by CodeRabbit

  • Chores
    • Added CI workflows: Go linting, Markdown link checks, spell check, vulnerability scans, and changelog checks/linters.
    • Added GolangCI config, Nancy ignore, Makefile, changelog config, and updated .gitignore.
    • Centralized build/format/lint/license/vuln tasks and automated tooling in CI.
  • Documentation
    • Added CHANGELOG.md entry for unreleased CI improvements.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Aug 26, 2025

Walkthrough

Adds multiple CI workflows (lint, markdown link check, spell check, vulnerability scans, changelog checks), GolangCI-Lint config, Nancy ignore file, Makefile, changelog config, updates .gitignore, and a new CHANGELOG.md entry.

Changes

Cohort / File(s) Summary
CI workflows
.github/workflows/golangci.yaml, .github/workflows/markdown-link-check.yaml, .github/workflows/spell-check.yaml, .github/workflows/vuln_nancy.yaml, .github/workflows/changelog-diff.yaml, .github/workflows/changelog-lint.yaml
New GitHub Actions workflows for Go linting (golangci-lint), Markdown link checking, spell checking (codespell), vulnerability scanning (Nancy and govulncheck), and changelog validation/linting.
Lint/Format config
.golangci.yaml
New GolangCI-Lint configuration enabling many linters, generated-code exclusions, formatting rules (gci, gofmt, gofumpt, golines), and govet settings.
Vulnerability ignore
.nancy-ignore
Adds Nancy ignore list with specified CVE IDs and inline notes.
Repository config
.gitignore, .clconfig.json, CHANGELOG.md
Uncomments editor ignores and adds build/; adds changelog config .clconfig.json; creates initial CHANGELOG.md entry.
Build / tooling
Makefile
New Makefile with targets for build, install, license apply/check, format, lint, vuln scans (nancy, govulncheck), and aggregated tooling; uses Docker-based tool invocations.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Dev as Developer
  participant GH as GitHub
  participant Runner as Actions Runner
  participant Linters as golangci-lint
  participant Spell as codespell
  participant LinkChk as markdown-link-check
  participant Nancy as Nancy / govulncheck
  participant Changelog as changelog-check/lint

  rect rgb(245,250,255)
    note over GH,Runner: PRs / pushes trigger workflows
    GH->>Runner: start workflows
  end

  par Linting & Formatting
    Runner->>Linters: run (config: .golangci.yaml)
    Linters-->>Runner: results
  and Spell & Links
    Runner->>Spell: run codespell (markdown paths)
    Spell-->>Runner: results
    Runner->>LinkChk: run link check
    LinkChk-->>Runner: results
  and Vulnerability Scans
    Runner->>Nancy: run nancy (uses .nancy-ignore)
    Nancy-->>Runner: scan results
    Runner->>Nancy: run govulncheck ./...
    Nancy-->>Runner: vulncheck results
  and Changelog Checks
    Runner->>Changelog: validate CHANGELOG.md / lint
    Changelog-->>Runner: results
  end

  Runner-->>GH: report statuses
  GH-->>Dev: display checks
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

I twitch my whiskers at CI’s light,
New workflows bustle through the night,
Linters hop and links get checked,
Spells corrected, CVEs deflect.
Makefile drums a tidy beat—
The warren’s tidy, workflow neat. 🐇

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Free

💡 Knowledge Base configuration:

  • Jira integration is disabled
  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between ff4330b and c5a8238.

📒 Files selected for processing (5)
  • .clconfig.json (1 hunks)
  • .github/workflows/changelog-diff.yaml (1 hunks)
  • .github/workflows/changelog-lint.yaml (1 hunks)
  • .github/workflows/golangci.yaml (1 hunks)
  • CHANGELOG.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • CHANGELOG.md

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Join our Discord community for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown

@0xstepit 0xstepit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added two questions but looks good to me!

Comment thread .github/workflows/vuln_nancy.yaml
Comment thread .nancy-ignore
@MalteHerrmann MalteHerrmann merged commit 43cb2ed into main Aug 26, 2025
3 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants