Skip to content

fix(ci): Improve docs-only branches#6876

Open
PeterSchafer wants to merge 1 commit into
mainfrom
chore/improve_docs_branch
Open

fix(ci): Improve docs-only branches#6876
PeterSchafer wants to merge 1 commit into
mainfrom
chore/improve_docs_branch

Conversation

@PeterSchafer

@PeterSchafer PeterSchafer commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Pull Request Submission Checklist

  • Follows CONTRIBUTING guidelines
  • Commit messages
    are release-note ready, emphasizing
    what was changed, not how.
  • Includes detailed description of changes
  • Contains risk assessment (Low | Medium | High)
  • Highlights breaking API changes (if applicable)
  • Links to automated tests covering new functionality
  • Includes manual testing instructions (if necessary)
  • Updates relevant GitBook documentation (PR link: ___)
  • Includes product update to be announced in the next stable release notes

What does this PR do?

improve docs only branches, to use linting and not build public cli

Where should the reviewer start?

How should this be manually tested?

What's the product update that needs to be communicated to CLI users?

@PeterSchafer PeterSchafer requested a review from a team as a code owner June 2, 2026 16:56
@snyk-io

snyk-io Bot commented Jun 2, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@snyk-pr-review-bot

This comment has been minimized.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@PeterSchafer PeterSchafer force-pushed the chore/improve_docs_branch branch from c2712b8 to 786f50e Compare June 16, 2026 13:27
@snyk-pr-review-bot

Copy link
Copy Markdown

PR Reviewer Guide 🔍

🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

High Blast Radius 🟠 [major]

The docs-only-check job now executes make lint (line 1505). This means a documentation-only PR will fail if there are any existing linting violations in the codebase, even if those violations are unrelated to the documentation changes. This forces documentation contributors to fix unrelated code linting issues or wait for main to be fixed before they can merge simple text updates.

- run:
    name: Linting project
    command: make lint
CI Overhead 🟡 [minor]

The docs-only-check job now performs a full npm ci and Go installation (lines 1494-1502) for every documentation change. This significantly increases the execution time and resource consumption of a job intended to be a lightweight check, potentially slowing down the feedback loop for documentation contributors.

- run:
    name: Installing dependencies
    command: npm ci --no-audit --no-progress
- install-go:
    go_os: linux
    go_target_os: linux
    go_arch: amd64
    base_url: << pipeline.parameters.go_download_base_url >>
    extraction_path: '/tmp'
- setup-go-private-modules
📚 Repository Context Analyzed

This review considered 5 relevant code sections from 3 files (average relevance: 0.81)

🤖 Repository instructions applied (from AGENTS.md)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant