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
Copy link
Copy Markdown
Contributor

@PeterSchafer PeterSchafer commented Jun 2, 2026

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?

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
@PeterSchafer PeterSchafer requested a review from a team as a code owner June 2, 2026 16:56
@snyk-io
Copy link
Copy Markdown

snyk-io Bot commented Jun 2, 2026

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
Copy link
Copy Markdown

PR Reviewer Guide 🔍

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

Blocks External Contributions 🟠 [major]

The docs-only-check job now requires the go-private-modules context. External contributors from forks do not have access to these secrets. Since CONTRIBUTING.md recommends using docs/ branch prefixes for documentation, this change will cause all community-submitted documentation PRs to fail CI, as they cannot satisfy the private module requirement. Documentation branches should remain accessible without private credentials.

context:
  - devex_cli_docker_hub
  - go-private-modules
Inefficient CI Steps 🟡 [minor]

The docs-only-check job now executes npm ci without using the caching mechanisms (restore_cache/save_cache) found in the prepare-build job. Additionally, it runs make lint, which targets TypeScript and Go code. Since the job's initial script (lines 1466-1481) guarantees that only documentation and assets are changed, running a full code lint is redundant and significantly slows down the feedback loop for documentation changes.

- 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
- run:
    name: Linting project
    command: make lint
📚 Repository Context Analyzed

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

🤖 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