docs: add a GitLab CI example to the README (closes #231) - #343
Open
dchaudhari7177 wants to merge 1 commit into
Open
docs: add a GitLab CI example to the README (closes #231)#343dchaudhari7177 wants to merge 1 commit into
dchaudhari7177 wants to merge 1 commit into
Conversation
The README showed only a GitHub Actions workflow. Adds a ready-to-paste .gitlab-ci.yml under the CI section, plus the setup-ci invocation that writes it. The snippet is not hand-written: it is the exact output of gitlabCiYaml() in src/commands/init-ci.ts for the --command form, so the README and `setup-ci --ci-provider gitlab-ci` cannot drift apart. That was the issue's fourth acceptance point. Notes the SARIF is published as a GitLab `sast` report, which is what makes findings show up in the merge request security widget rather than just sitting in the job log. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
dchaudhari7177
force-pushed
the
docs/gitlab-ci-example
branch
from
August 15, 2026 04:03
b0c7f57 to
6a75d07
Compare
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
2 participants
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.
Closes #231. Part of #221.
The README showed only a GitHub Actions workflow. Adds a
### GitLab CIsubsection with a ready-to-paste.gitlab-ci.yml, plus thesetup-ciinvocation that writes it for you.The snippet is generated, not hand-written
The issue's fourth point was that the example must match what
setup-cigenerates. Rather than eyeball it, I executedgitlabCiYaml()fromsrc/commands/init-ci.tsfor the--commandform and pasted its exact output — so the README and the generator cannot drift apart.The description calls out that the SARIF is published as a GitLab
sastreport — that's what makes findings appear in the merge-request security widget rather than sitting in the job log, and it's the non-obvious part of the template.Verified the embedded YAML parses (
yaml.safe_load). Docs-only change.🤖 Generated with Claude Code