Docs: Add CI Integrations guide with per-provider pages#1684
Open
arzezak wants to merge 1 commit into
Open
Conversation
github-actions
Bot
added
the
documentation
arzezak
force-pushed
the
docs/ci
branch
2 times, most recently
from
5c58e18 to
b61a7a7
Compare
Addresses marcoroth#353, which asks for copy-paste snippets showing how to run the Herb linter, formatter, and `herb analyze` in popular CI pipelines. The new section mirrors the structure of Editor Integrations: an overview page at `integrations/ci.md` plus one subpage per provider (GitHub Actions, GitLab CI, Bitbucket Pipelines, Reviewdog), wired into the sidebar between Editor Integrations and Language Bindings. Sources: Herb-specific claims (linter/formatter flags, exit codes, JSON shape, `herb analyze` gating) are grounded in the linter and formatter source under `javascript/packages/` and in `lib/herb/cli.rb`. CI-platform specifics come from the respective vendor docs — GitHub Actions workflow syntax, GitLab Code Quality report schema, Bitbucket Pipelines YAML, and Reviewdog's rdjson spec — and are not verified against this repo.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses #353, which asks for copy-paste snippets showing how to run the Herb linter, formatter, and
herb analyzein popular CI pipelines.The new section mirrors the structure of Editor Integrations: an overview page at
integrations/ci.mdplus one subpage per provider (GitHub Actions, GitLab CI, Bitbucket Pipelines, Reviewdog), wired into the sidebar between Editor Integrations and Language Bindings.Sources
Herb-specific claims (linter/formatter flags, exit codes, JSON shape,
herb analyzegating) are grounded in the linter and formatter source underjavascript/packages/and inlib/herb/cli.rb. CI-platform specifics come from the respective vendor docs — GitHub Actions workflow syntax, GitLab Code Quality report schema, Bitbucket Pipelines YAML, and Reviewdog's rdjson spec — and are not verified against this repo.