Add Feature Flags docs #2585
Add Feature Flags docs #2585
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis update introduces new documentation for Pipelines feature flags and the ignore list functionality, adds corresponding sidebar entries, and updates configuration documentation to describe how to use ignore filters in both HCL and YAML formats. Additionally, two new terms were added to the custom dictionary. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant Pipelines
User->>Docs: Reads about feature flags and ignore list
User->>Pipelines: Configures feature flags via env vars in HCL/YAML
User->>Pipelines: Sets ignore-list patterns in config
Pipelines->>Pipelines: Applies feature flags and ignore filters during run
Possibly related PRs
Poem
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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: 2
🧹 Nitpick comments (2)
docs/2.0/reference/pipelines/feature-flags.md (2)
8-13: Grammar: add commas for clarity
- After “e.g.” add a comma: “e.g., when both FileChanged…”
- After “Additionally” add a comma: “Additionally, pipelines will execute…”
🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: A comma may be missing after the conjunctive/linking adverb ‘Additionally’.
Context: ...hould trigger a plan in the same unit. Additionally pipelines will execute terragrunt with ...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
🪛 markdownlint-cli2 (0.17.2)
8-8: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
47-75: Consistent headings & reduce repetition
- Update the remaining flag headings from
####to###to maintain a proper heading hierarchy.- The sentence “This is a break-glass feature flag and can be used to disable this functionality if it is causing issues.” appears twice; consider extracting it into a shared note or rephrasing one occurrence for variety.
🧰 Tools
🪛 LanguageTool
[style] ~66-~66: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ands liketerragrunt stack generate. This is a break-glass feature flag and can b...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/2.0/reference/pipelines/feature-flags.md(1 hunks)sidebars/reference.js(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/2.0/reference/pipelines/feature-flags.md
[uncategorized] ~12-~12: A comma may be missing after the conjunctive/linking adverb ‘Additionally’.
Context: ...hould trigger a plan in the same unit. Additionally pipelines will execute terragrunt with ...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[typographical] ~35-~35: It seems that a comma is missing.
Context: ...dir1/myvars.json ``` When this flag is enabled Pipelines will detect changes to `dir1/...
(IF_COMMA)
[duplication] ~35-~35: Possible typo: you repeated a word.
Context: ...tory. While tags.yml will be detected as as a FileChanged event and Pipelines will ...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~66-~66: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ands like terragrunt stack generate. This is a break-glass feature flag and can b...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
docs/2.0/reference/pipelines/feature-flags.md
8-8: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
29-29: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Validate generated content
- GitHub Check: validate_build
🔇 Additional comments (2)
docs/2.0/reference/pipelines/feature-flags.md (1)
1-4: Title and introduction are clear
The main heading and introductory paragraph effectively explain feature flags and link to the correct HCL/YAML env-block references.sidebars/reference.js (1)
56-60: Sidebar entry added correctly
The new “Feature Flags” doc link is properly formatted under the “Gruntwork Pipelines” section and points to the correct ID. No changes needed here.
| E.g. given a repository containing the following files: | ||
| ``` | ||
| tags.yml | ||
| dir1/terragrunt.hcl | ||
| dir1/myvars.json | ||
| ``` | ||
|
|
||
| When this flag is enabled Pipelines will detect changes to `dir1/myvars.json` as a ModuleChanged for `dir1` and run Terragrunt Plan/Apply for this directory. While `tags.yml` will be detected as as a FileChanged event and Pipelines will run Terragrunt with [queue-include-units-reading](https://terragrunt.gruntwork.io/docs/reference/cli-options/#queue-include-units-reading) for this file. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Specify code block language & clean up grammar
- Annotate the fenced block with a language (e.g., ```text) for proper rendering.
- Add a comma after “When this flag is enabled,” for readability.
- Remove the duplicated “as” in “detected as as a FileChanged event.”
🧰 Tools
🪛 LanguageTool
[typographical] ~35-~35: It seems that a comma is missing.
Context: ...dir1/myvars.json ``` When this flag is enabled Pipelines will detect changes to `dir1/...
(IF_COMMA)
[duplication] ~35-~35: Possible typo: you repeated a word.
Context: ...tory. While tags.yml will be detected as as a FileChanged event and Pipelines will ...
(ENGLISH_WORD_REPEAT_RULE)
🪛 markdownlint-cli2 (0.17.2)
29-29: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
| ## Available Flags | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix heading level jump
You have an h2 (## Available Flags) followed immediately by h4 (####) for each flag. Markdown lint requires stepping one level at a time. Please change each flag heading from #### to ###.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/2.0/reference/pipelines/ignore-filter.md (4)
7-12: Refine wildcard syntax descriptions
The Syntax bullets can be made clearer and more consistent. For example:- - `:` Is used as a separator between filters - - `*` Matches any character except `/`, for matches within a specific directory. - - `**` Matches any character, for matches across multiple directories. + - `:` is used as a separator between patterns. + - `*` matches any sequence of characters except `/`, within a single directory. + - `**` matches any sequence of characters, including `/`, across multiple directory levels.🧰 Tools
🪛 LanguageTool
[grammar] ~9-~9: This sentence seems to be incomplete. Insert a noun before ‘Is’ to make the sentence complete.
Context: ... separated by the:character. -:Is used as a separator between filters - `...(MISSING_SUBJECT)
15-20: Use bullet list for specific-file examples
Formatting each pattern example as a Markdown list improves readability:### Ignore specific files - `myfile.yml` — Matches the exact path to this file at the root level. - `myfile.yml:a/b/c/myfile.yml` — Matches both of these specific paths.
21-24: Add missing article in heading
For grammatical correctness, include “the” in the heading:- ### Ignore all files with extension .md + ### Ignore all files with the .md extension🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: You might be missing the article “the” here.
Context: ...em with:. ### Ignore all files with extension .md**.md- Matches all paths ending...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
33-36: Add missing article in directory-specific extension example
Include “the” in this heading too:- ### Ignore all files with extension .md in a directory + ### Ignore all files with the .md extension in a directory🧰 Tools
🪛 LanguageTool
[uncategorized] ~33-~33: You might be missing the article “the” here.
Context: ... be ignored. ### Ignore all files with extension .md in a directorydocs/**.md- Matc...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
custom-dictionary.txt(1 hunks)docs/2.0/reference/pipelines/ignore-filter.md(1 hunks)sidebars/reference.js(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- custom-dictionary.txt
🚧 Files skipped from review as they are similar to previous changes (1)
- sidebars/reference.js
🧰 Additional context used
🪛 LanguageTool
docs/2.0/reference/pipelines/ignore-filter.md
[grammar] ~9-~9: This sentence seems to be incomplete. Insert a noun before ‘Is’ to make the sentence complete.
Context: ... separated by the : character. - : Is used as a separator between filters - `...
(MISSING_SUBJECT)
[uncategorized] ~21-~21: You might be missing the article “the” here.
Context: ...em with :. ### Ignore all files with extension .md **.md - Matches all paths ending...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~33-~33: You might be missing the article “the” here.
Context: ... be ignored. ### Ignore all files with extension .md in a directory docs/**.md - Matc...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Validate generated content
- GitHub Check: Pull Request has non-contributor approval
- GitHub Check: validate_build
🔇 Additional comments (5)
docs/2.0/reference/pipelines/ignore-filter.md (5)
1-2: Title is clear and consistent
The page title “Pipelines Ignore Filter” follows the same Title Case convention as “Feature Flags” and concisely describes the feature.
3-4: Verify HCL/YAML reference links
Please confirm that the[HCL](/2.0/reference/pipelines/configurations-as-code/api#env-block)and[YAML](/2.0/reference/pipelines/configurations#env)links resolve correctly in your documentation site.
25-28: README.md example is clear
The patternREADME.md:**/README.mdeffectively shows how to ignore both the root README.md and any nested README.md files.
29-32: Directory-wide ignore example is clear
Thea/**pattern correctly demonstrates ignoring all files within a directory and its subdirectories.
37-41: Examples look good
The final example (a/*) is well explained and aligns with the other patterns.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/2.0/reference/pipelines/ignore-filter.md (3)
9-11: Unify bullet list grammar and punctuation
The three syntax bullets are inconsistent in capitalization and punctuation. For clarity and consistency, consider rephrasing as follows:- - `,` Is used as a separator between filters - - `*` Matches any character except `/`, for matches within a specific directory. - - `**` Matches any character, for matches across multiple directories. + - `,`: used to separate multiple patterns. + - `*`: matches any character except `/` within a single directory segment. + - `**`: matches any character across multiple directory segments.🧰 Tools
🪛 LanguageTool
[grammar] ~9-~9: This sentence seems to be incomplete. Insert a noun before ‘Is’ to make the sentence complete.
Context: ... separated by the,character. -,Is used as a separator between filters - `...(MISSING_SUBJECT)
21-23: Add missing article for clarity
The header is missing “the” before “extension”:- ### Ignore all files with extension .md + ### Ignore all files with the extension `.md`🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: You might be missing the article “the” here.
Context: ...em with,. ### Ignore all files with extension .md**.md- Matches all paths ending...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
33-36: Add missing article and inline code formatting
Similarly, prepend “the” in this header and wrap.mdin backticks:- ### Ignore all files with extension .md in a directory + ### Ignore all files with the extension `.md` in a directory🧰 Tools
🪛 LanguageTool
[uncategorized] ~33-~33: You might be missing the article “the” here.
Context: ... be ignored. ### Ignore all files with extension .md in a directorydocs/**.md- Matc...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2.0/reference/pipelines/ignore-filter.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/2.0/reference/pipelines/ignore-filter.md
[grammar] ~9-~9: This sentence seems to be incomplete. Insert a noun before ‘Is’ to make the sentence complete.
Context: ... separated by the , character. - , Is used as a separator between filters - `...
(MISSING_SUBJECT)
[uncategorized] ~21-~21: You might be missing the article “the” here.
Context: ...em with ,. ### Ignore all files with extension .md **.md - Matches all paths ending...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~33-~33: You might be missing the article “the” here.
Context: ... be ignored. ### Ignore all files with extension .md in a directory docs/**.md - Matc...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (2)
docs/2.0/reference/pipelines/feature-flags.md (2)
8-8: Fix heading level jumpThe document uses level-4 headings (
####) for each flag immediately under an H2 (## Available Flags). Markdown best practices require stepping one level at a time—please convert these to level-3 headings (###).Also applies to: 21-21, 34-34, 58-58, 73-73, 88-88
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
8-8: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
46-46: 🛠️ Refactor suggestionFix duplicated word and add missing comma
There's a double "as" and a missing comma for clarity. Consider rewriting the sentence:
- When this flag is enabled Pipelines will detect changes to `dir1/myvars.json` as a ModuleChanged for `dir1` and run Terragrunt Plan/Apply for this directory. While `tags.yml` will be detected as as a FileChanged event and Pipelines will run Terragrunt with [queue-include-units-reading](https://terragrunt.gruntwork.io/docs/reference/cli-options/#queue-include-units-reading) for this file. + When this flag is enabled, Pipelines will detect changes to `dir1/myvars.json` as a ModuleChanged job for `dir1` and run Terragrunt Plan/Apply accordingly. Meanwhile, `tags.yml` will be detected as a FileChanged event and Pipelines will run Terragrunt with [queue-include-units-reading](https://terragrunt.gruntwork.io/docs/reference/cli-options/#queue-include-units-reading) for that file.🧰 Tools
🪛 LanguageTool
[typographical] ~46-~46: It seems that a comma is missing.
Context: ...dir1/myvars.json ``` When this flag is enabled Pipelines will detect changes to `dir1/...(IF_COMMA)
[duplication] ~46-~46: Possible typo: you repeated a word.
Context: ...tory. Whiletags.ymlwill be detected as as a FileChanged event and Pipelines will ...(ENGLISH_WORD_REPEAT_RULE)
🧹 Nitpick comments (3)
docs/2.0/reference/pipelines/ignore-list.md (2)
9-9: Fix grammar in comma-separator bullet
Change "-,Is used as a separator between filters" to something like:- `,` Is used as a separator between filters + The `,` character is used to separate multiple filter patterns.🧰 Tools
🪛 LanguageTool
[grammar] ~9-~9: This sentence seems to be incomplete. Insert a noun before ‘Is’ to make the sentence complete.
Context: ... separated by the,character. -,Is used as a separator between filters - `...(MISSING_SUBJECT)
10-11: Ensure consistency in bullet phrasing
For uniformity, consider starting each bullet with “The” and using parallel verb forms. For example:- `*` Matches any character except `/`, for matches within a specific directory. - `**` Matches any character, for matches across multiple directories. + The `*` pattern matches any character except `/` (within a single directory). + The `**` pattern matches any character across multiple directory levels.docs/2.0/reference/pipelines/feature-flags.md (1)
26-26: Add missing comma before "but" for consistencySeveral flag descriptions use:
"This behavior will likely become the default in a major release of Pipelines but is currently opt-in…"
Please insert a comma before "but" in each occurrence:
- ...release of Pipelines but is currently opt-in... + ...release of Pipelines, but is currently opt-in...This applies to lines 26, 48, and 63.
Also applies to: 48-48, 63-63
🧰 Tools
🪛 LanguageTool
[uncategorized] ~26-~26: Possible missing comma found.
Context: ... default in a major release of Pipelines but is currently opt-in due to being a brea...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/2.0/reference/pipelines/configurations-as-code/api.md(1 hunks)docs/2.0/reference/pipelines/configurations.md(1 hunks)docs/2.0/reference/pipelines/feature-flags.md(1 hunks)docs/2.0/reference/pipelines/ignore-list.md(1 hunks)sidebars/reference.js(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- docs/2.0/reference/pipelines/configurations.md
- docs/2.0/reference/pipelines/configurations-as-code/api.md
🚧 Files skipped from review as they are similar to previous changes (1)
- sidebars/reference.js
🧰 Additional context used
🪛 LanguageTool
docs/2.0/reference/pipelines/feature-flags.md
[uncategorized] ~26-~26: Possible missing comma found.
Context: ... default in a major release of Pipelines but is currently opt-in due to being a brea...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~46-~46: It seems that a comma is missing.
Context: ...dir1/myvars.json ``` When this flag is enabled Pipelines will detect changes to `dir1/...
(IF_COMMA)
[duplication] ~46-~46: Possible typo: you repeated a word.
Context: ...tory. While tags.yml will be detected as as a FileChanged event and Pipelines will ...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~48-~48: Possible missing comma found.
Context: ... default in a major release of Pipelines but is currently opt-in due to being a brea...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~63-~63: Possible missing comma found.
Context: ... default in a major release of Pipelines but is currently opt-in due to being a brea...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~77-~77: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...options/#queue-include-units-reading). This is a break-glass feature flag and can b...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~92-~92: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ands like terragrunt stack generate. This is a break-glass feature flag and can b...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/2.0/reference/pipelines/ignore-list.md
[grammar] ~9-~9: This sentence seems to be incomplete. Insert a noun before ‘Is’ to make the sentence complete.
Context: ... separated by the , character. - , Is used as a separator between filters - `...
(MISSING_SUBJECT)
[uncategorized] ~21-~21: You might be missing the article “the” here.
Context: ...em with ,. ### Ignore all files with extension .md **.md - Matches all paths ending...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~33-~33: You might be missing the article “the” here.
Context: ... be ignored. ### Ignore all files with extension .md in a directory docs/**.md - Matc...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
docs/2.0/reference/pipelines/feature-flags.md
8-8: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
40-40: 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: Validate generated content
- GitHub Check: Pull Request has non-contributor approval
- GitHub Check: validate_build
🔇 Additional comments (7)
docs/2.0/reference/pipelines/ignore-list.md (7)
3-4: Verify the accuracy of documentation links
Please ensure that the[HCL](/2.0/reference/pipelines/configurations-as-code/api#ignore_list)and[YAML](/2.0/reference/pipelines/configurations#ignore-list)anchors actually exist in your generated site and point to the correct sections.
5-8: Looks good: Syntax section and description
The heading and introductory sentence clearly explain the ignore-list configuration.
13-16: Approve Common Examples heading and first example
The “Common Examples” heading and “Ignore specific files” section are clear and correctly formatted.
17-20: Approve specific-files example
The two-path pattern example is correct and the explanatory text is clear.
25-28: Approve README.md ignore example
The combined root and subdirectory README.md pattern is correct and well-explained.
29-32: Approve directory-only ignore example
Thea/**pattern and description accurately cover ignoring files in a directory and its subdirectories.
37-40: Approve top-level only ignore example
Thea/*pattern correctly conveys that subdirectories are excluded.
| ### Ignore all files with extension .md in a directory | ||
|
|
||
| `docs/**.md` - Matches all .md files in the docs directory and its subdirectories. For example, `docs/file.md` will be ignored, but not `docs/file.yml`. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Clarify .md-in-directory example and pattern
For consistency and accuracy, adjust to:
- ### Ignore all files with extension .md in a directory
+ ### Ignore all files with the .md extension in the docs directory
- `docs/**.md` - Matches all .md files in the docs directory and its subdirectories.
+ `docs/**/*.md` - Matches all .md files in the docs directory and its subdirectories.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Ignore all files with extension .md in a directory | |
| `docs/**.md` - Matches all .md files in the docs directory and its subdirectories. For example, `docs/file.md` will be ignored, but not `docs/file.yml`. | |
| ### Ignore all files with the .md extension in the docs directory | |
| `docs/**/*.md` - Matches all .md files in the docs directory and its subdirectories. For example, `docs/file.md` will be ignored, but not `docs/file.yml`. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~33-~33: You might be missing the article “the” here.
Context: ... be ignored. ### Ignore all files with extension .md in a directory docs/**.md - Matc...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🤖 Prompt for AI Agents
In docs/2.0/reference/pipelines/ignore-list.md around lines 33 to 36, clarify
the example and pattern for ignoring .md files in a directory by adjusting the
explanation to accurately reflect that the pattern `docs/**/*.md` matches all
.md files in the docs directory and all its subdirectories, ensuring consistency
and correctness in the description.
| ### Ignore all files with extension .md | ||
|
|
||
| `**.md` - Matches all paths ending in .md, regardless of directory depth. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Clarify .md extension example and pattern
The heading and pattern can be more precise. Update as follows:
- ### Ignore all files with extension .md
+ ### Ignore all files with the .md extension
- `**.md` - Matches all paths ending in .md, regardless of directory depth.
+ `**/*.md` - Matches all paths ending in .md, regardless of directory depth.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Ignore all files with extension .md | |
| `**.md` - Matches all paths ending in .md, regardless of directory depth. | |
| ### Ignore all files with the .md extension | |
| `**/*.md` - Matches all paths ending in .md, regardless of directory depth. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: You might be missing the article “the” here.
Context: ...em with ,. ### Ignore all files with extension .md **.md - Matches all paths ending...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🤖 Prompt for AI Agents
In docs/2.0/reference/pipelines/ignore-list.md around lines 21 to 24, clarify
the example and pattern for ignoring .md files by updating the heading to
explicitly mention ignoring all files with the .md extension and revise the
pattern to use a more precise glob pattern like '**/*.md' to match all markdown
files at any directory depth.
| ``` | ||
| tags.yml | ||
| dir1/terragrunt.hcl | ||
| dir1/myvars.json | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Specify fenced code block language
The sample file layout is wrapped in a fenced code block without a language identifier. Add one (e.g., text) so markdown linting passes and rendering is correct.
- ```
+ ```text
tags.yml
dir1/terragrunt.hcl
dir1/myvars.json
- ```
+ ```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
40-40: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In docs/2.0/reference/pipelines/feature-flags.md around lines 40 to 44, the
fenced code block showing the sample file layout lacks a language identifier,
which can cause markdown linting issues and improper rendering. Add a language
specifier like "text" immediately after the opening triple backticks to fix
this, so the block starts with ```text instead of just ```.
Summary by CodeRabbit
New Features
Documentation