archlint
ActionsPrevent architectural regressions in your Pull Requests with beautiful comments and annotations
v1.0.1
LatestBy archlinter
Tags
(2)
Official GitHub Action for archlint to prevent architectural regressions in your Pull Requests.
- 🚀 Architectural Gate: Block PRs that introduce new circular dependencies, layer violations, or other smells.
- 📝 Beautiful PR Comments: Detailed reports with "Why" and "How to fix" explanations.
- 📍 Inline Annotations: See exactly where architectural issues occur in your code diff.
- ⚙️ Ratchet Approach: Enforce improvement without forcing a full rewrite—just don't let it get worse.
Create a .github/workflows/architecture.yml file in your repository:
name: Architecture
on:
pull_request:
branches: [ main ]
jobs:
arch-check:
name: Architecture Gate
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write # Required for posting comments and annotations
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # Important: Required for git diff comparison
- name: Run archlint
uses: archlinter/action@v1
with:
# Compare current PR against the target branch
baseline: origin/${{ github.base_ref }}
# Fail only on medium or higher severity smells
fail-on: medium
# Enable PR commenting
comment: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}| Input | Description | Default |
|---|---|---|
baseline |
Git ref (branch/tag/commit) or path to a snapshot file to compare against. | origin/main |
fail-on |
Minimum severity to cause the action to fail. Options: low, medium, high, critical. |
medium |
comment |
Whether to post a summary report as a PR comment. | true |
annotations |
Whether to show inline annotations in the "Files changed" tab. | true |
working-directory |
Directory where archlint should run (useful for monorepos). |
. |
github-token |
Token used for API requests. | ${{ github.token }} |
If your project is in a subdirectory:
- uses: archlinter/action@v1
with:
working-directory: ./packages/backend
baseline: origin/mainIf you prefer to compare against a pre-generated snapshot:
- uses: archlinter/action@v1
with:
baseline: .archlint/baseline.jsonThis action requires the following permissions:
permissions:
contents: read # To checkout code
pull-requests: write # To post comments and annotationsMIT © archlint
archlint is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
About
v1.0.1
LatestBy archlinter
Tags
(2)archlint is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.