[WIP] Add pipelines installation instructions for custom GitLab instances #2547
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe updates focus on documentation improvements and minor configuration adjustments. The installation guide for adding Pipelines to a GitLab repository was enhanced with detailed instructions for users of custom GitLab instances, including new notes, clearer formatting, and updated version references. Additionally, the documentation sidebar configuration was updated to correct a label and fix a formatting issue, ensuring accurate navigation and structure within the documentation. Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/2.0/docs/pipelines/installation/addinggitlabrepo.md (1)
44-49: Improved formatting of email instructions.Using a code block with clear placeholders makes it easier for users to understand what information they need to provide. The explicit example of a custom GitLab instance URL is particularly helpful.
Consider specifying a language for the code block to improve formatting:
- ``` + ```text GitLab group name(s): $$GITLAB_GROUP_NAME$$ (e.g. acme-io) GitLab instance URL: $$GITLAB_INSTANCE$$ (e.g., https://gitlab.acme.io) Organization name: $$ORGANIZATION_NAME$$ (e.g. Acme, Inc.) ```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
45-45: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/2.0/docs/pipelines/installation/addinggitlabrepo.md(4 hunks)sidebars/docs.js(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/2.0/docs/pipelines/installation/addinggitlabrepo.md
[grammar] ~20-~20: The singular proper name ‘GitLab’ must be used with a third-person or a past tense verb.
Context: ...nents to reside within the [same GitLab instance as the project referencing them](https:...
(HE_VERB_AGR)
🪛 markdownlint-cli2 (0.17.2)
docs/2.0/docs/pipelines/installation/addinggitlabrepo.md
45-45: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Validate generated content
🔇 Additional comments (6)
sidebars/docs.js (2)
262-262: Great terminology update to align with GitLab's language!Changing "Adding Pipelines to a GitLab Repository" to "Adding Pipelines to a GitLab Project" maintains consistency with GitLab's standard terminology, which refers to "projects" rather than "repositories". This improves clarity for users familiar with GitLab.
266-267: Good catch on adding the missing comma.The added comma fixes a syntax error in the sidebar configuration object which could potentially cause JavaScript errors or unexpected behavior.
docs/2.0/docs/pipelines/installation/addinggitlabrepo.md (4)
16-23: Excellent addition of custom GitLab instance guidance!This clear information box provides crucial instructions for users with custom GitLab instances. The explanation of why forking is necessary (due to GitLab's requirement that CI/CD components must reside in the same instance) helps users understand the technical reasoning behind this step.
🧰 Tools
🪛 LanguageTool
[grammar] ~20-~20: The singular proper name ‘GitLab’ must be used with a third-person or a past tense verb.
Context: ...nents to reside within the [same GitLab instance as the project referencing them](https:...(HE_VERB_AGR)
109-109: Helpful reminder for custom instance users.This addition ensures that users with custom GitLab instances remember to review and update instance-specific variables in their configuration.
134-136: Important clarification for OIDC configuration.Correcting the file type description from "Terraform files" to "Terragrunt files" and adding the note about verifying OIDC configuration for custom GitLab instances helps prevent potential authentication issues.
113-113:❓ Verification inconclusive
Version update to support new features.
Updating the boilerplate template URL from v2.12.10 to v2.13.0 ensures users get the latest version with custom GitLab instance support.
🏁 Script executed:
#!/bin/bash # Verify that v2.13.0 has been released or will be released soon # Check if the tag exists in the architecture catalog repository echo "Checking if v2.13.0 exists in the architecture catalog repository..." git ls-remote --tags https://github.com/gruntwork-io/terraform-aws-architecture-catalog.git | grep "v2.13.0" # Check if there's a PR mentioned in the PR objectives echo "Looking for related PR 1143 in terraform-aws-architecture-catalog..." gh api repos/gruntwork-io/terraform-aws-architecture-catalog/pulls/1143 --jq '.title, .state, .html_url'Length of output: 786
Please verify the
v2.13.0tag and repo path before bumping the template URLIt looks like the docs were updated to point at
[email protected]:gruntwork-io/terraform-aws-architecture-catalog.git//…?ref=v2.13.0but our automated check couldn’t find that repo or tag on GitHub. Before merging:
- Confirm the correct repository path (it may be private or renamed)
- Ensure the
v2.13.0tag has been published- If it isn’t available yet, revert to
v2.12.10or hold until the release is livedocs/2.0/docs/pipelines/installation/addinggitlabrepo.md:113
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/2.0/docs/pipelines/installation/addinggitlabrepo.md (1)
45-49: Specify a language for the fenced code block
Markdown linting flags recommend adding a language identifier to fenced code blocks. Since this is a simple placeholder snippet, consider:- ``` + ```textThis will satisfy Markdown lint rules and improve readability.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
45-45: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2.0/docs/pipelines/installation/addinggitlabrepo.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/2.0/docs/pipelines/installation/addinggitlabrepo.md
[grammar] ~20-~20: The singular proper name ‘GitLab’ must be used with a third-person or a past tense verb.
Context: ...nents to reside within the [same GitLab instance as the project referencing them](https:...
(HE_VERB_AGR)
🪛 markdownlint-cli2 (0.17.2)
docs/2.0/docs/pipelines/installation/addinggitlabrepo.md
45-45: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Pull Request has non-contributor approval
- GitHub Check: validate_build
- GitHub Check: Validate generated content
🔇 Additional comments (4)
docs/2.0/docs/pipelines/installation/addinggitlabrepo.md (4)
16-23: Excellent addition: Custom instance fork instruction
This informational admonition clearly guides users of custom GitLab instances to fork and mirror the Pipelines workflow project in their own instance. It aligns perfectly with the PR objective of supporting configurable server options.🧰 Tools
🪛 LanguageTool
[grammar] ~20-~20: The singular proper name ‘GitLab’ must be used with a third-person or a past tense verb.
Context: ...nents to reside within the [same GitLab instance as the project referencing them](https:...(HE_VERB_AGR)
109-109: Great reminder for custom vars.yaml customization
This call-out helps users remember to override instance-specific settings invars.yaml. The phrasing is clear, concise, and on-point.
134-135: Solid note on OIDC provider configuration for custom instances
Reminding users to verify theURLandaudiencesinputs when using a custom GitLab instance is crucial. The placement and wording are effective and will help prevent misconfigurations.
113-113:❓ Verification inconclusive
Verify template version bump to v2.13.0
Before merging, ensure that thev2.13.0release of the architecture catalog templates is published and that PR #1143 has been merged. You can verify the tag exists with:
🏁 Script executed:
#!/bin/bash # Check that v2.13.0 is available in the remote repo git ls-remote --tags https://github.com/gruntwork-io/terraform-aws-architecture-catalog.git | grep "refs/tags/v2.13.0"Length of output: 250
Verify the
v2.13.0template bump
Before merging, please confirm both that PR #1143 has been merged and that thev2.13.0tag is published in theterraform-aws-architecture-catalogrepo. You can check with SSH or in your browser:• Via SSH:
git ls-remote --tags [email protected]:gruntwork-io/terraform-aws-architecture-catalog.git \ | grep "refs/tags/v2.13.0"• In your browser:
https://github.com/gruntwork-io/terraform-aws-architecture-catalog/releases/tag/v2.13.0
By updating the the necessary architecture catalog templates to allow configurable server options; it appears all the additional documentation that is:needed:
Required to merge
Summary by CodeRabbit