Pmc-20251201-docs

[petercrocker]

Summary by CodeRabbit

• Documentation

  • Improved formatting and presentation of SDK reference tables for better readability.

• Chores

  • Updated CI workflow tooling to the latest version for enhanced reliability.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

This pull request contains four distinct updates: the CI workflow upgrades the markdownlint-cli2-action from version 20 to version 21 without modifying any inputs or workflow logic. The remaining three changes are presentational updates to documentation files, specifically modifying Markdown table header formatting across the SDK template reference and documentation pages. These header changes affect only the visual presentation of tables related to builtin filters, netutils filters, and data processing parameters, with no alterations to underlying data, logic, or control flow.

Pre-merge checks

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Pmc-20251201-docs' is vague and does not clearly convey what changes are being made. It appears to be a ticket reference rather than a descriptive summary of the changes.	Replace the ticket reference with a descriptive title that summarizes the main changes, such as 'Update Markdown table headers and CI workflow' or 'Fix table formatting in docs and update linting action'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d51e287 and 89c5b0a.

📒 Files selected for processing (4)

• .github/workflows/ci.yml (1 hunks)
• docs/_templates/sdk_template_reference.j2 (2 hunks)
• docs/docs/python-sdk/reference/templating.mdx (2 hunks)
• docs/docs/python-sdk/topics/object_file.mdx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

docs/**/*.mdx

📄 CodeRabbit inference engine (CLAUDE.md)

Follow the Diataxis framework for documentation with four types: Tutorials (learning-oriented), How-to guides (task-oriented), Explanation (understanding-oriented), and Reference (information-oriented)

Files:

• docs/docs/python-sdk/topics/object_file.mdx
• docs/docs/python-sdk/reference/templating.mdx

docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (CLAUDE.md)

docs/**/*.{md,mdx}: Use professional but approachable tone, concise and direct language, and consistent document structure patterns following Diataxis categories in documentation
In documentation code examples: use proper language tags, include both async and sync examples using Tabs component where applicable, provide realistic examples, add validation steps, and use callouts for warnings and tips
Use domain-relevant Infrahub terminology (playbooks, branches, schemas, commits) consistently with Infrahub's data model and UI naming conventions in documentation
Validate documentation accuracy against the latest Infrahub version and follow markdown style as defined in .markdownlint.yaml and Vale styles

Files:

• docs/docs/python-sdk/topics/object_file.mdx
• docs/docs/python-sdk/reference/templating.mdx

🧠 Learnings (3)

📓 Common learnings

Learnt from: CR
Repo: opsmill/infrahub-sdk-python PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-01T19:42:19.002Z
Learning: Applies to docs/**/*.{md,mdx} : Validate documentation accuracy against the latest Infrahub version and follow markdown style as defined in `.markdownlint.yaml` and Vale styles

Learnt from: CR
Repo: opsmill/infrahub-sdk-python PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-01T19:42:19.002Z
Learning: Applies to docs/**/*.{md,mdx} : In documentation code examples: use proper language tags, include both async and sync examples using Tabs component where applicable, provide realistic examples, add validation steps, and use callouts for warnings and tips

📚 Learning: 2025-12-01T19:42:19.002Z

Learnt from: CR
Repo: opsmill/infrahub-sdk-python PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-01T19:42:19.002Z
Learning: Applies to docs/**/*.{md,mdx} : Validate documentation accuracy against the latest Infrahub version and follow markdown style as defined in `.markdownlint.yaml` and Vale styles

Applied to files:

• .github/workflows/ci.yml

📚 Learning: 2025-12-01T19:42:19.002Z

Learnt from: CR
Repo: opsmill/infrahub-sdk-python PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-01T19:42:19.002Z
Learning: Use Ruff (0.14.5) for comprehensive linting and formatting, mypy for type checking with strict configuration, yamllint for YAML files, markdownlint for documentation consistency, and Vale for documentation style

Applied to files:

• .github/workflows/ci.yml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)

• GitHub Check: unit-tests (3.12)
• GitHub Check: unit-tests (3.10)
• GitHub Check: unit-tests (3.13)
• GitHub Check: unit-tests (3.11)
• GitHub Check: integration-tests-latest-infrahub
• GitHub Check: documentation
• GitHub Check: Cloudflare Pages

🔇 Additional comments (6)

docs/docs/python-sdk/reference/templating.mdx (2)

12-12: Table header format updates align with markdownlint v21.

The Builtin Jinja2 filters table header separator was updated to use standard markdown syntax. The change maintains all data and filtering logic integrity.

---

74-74: Netutils filters table header format updated consistently.

The separator format matches the Builtin Jinja2 filters table, ensuring consistency across documentation. All filter data and trust indicators are preserved.

docs/docs/python-sdk/topics/object_file.mdx (1)

75-76: Data Processing Parameters table header improved for clarity.

The table header formatting was updated with extended spacing and proper separator alignment. The content remains accurate—the expand_range parameter description and default value are preserved unchanged.

docs/_templates/sdk_template_reference.j2 (2)

12-12: Builtin filters table header format updated in template.

The Jinja2 template header separator was updated to standard markdown format. The dynamic filter iteration and conditional rendering logic remain unchanged, so template behavior is preserved.

---

23-23: Netutils filters table header format updated consistently in template.

The separator format matches the Builtin filters table, ensuring consistency. The {% for %} loop iteration and trusted flag rendering logic are untouched.

.github/workflows/ci.yml (1)

99-99: No breaking changes between markdownlint-cli2 v20 and v21.

The version bump updates markdownlint from v0.38.0 to v0.39.0, which is a minor release with no breaking changes. Both versions use the same micromark parser and ESM module structure. The upgrade is safe to proceed with.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[cloudflare-workers-and-pages]

Deploying infrahub-sdk-python with    Cloudflare Pages

Latest commit:	89c5b0a
Status:	✅  Deploy successful!
Preview URL:	https://54ec0852.infrahub-sdk-python.pages.dev
Branch Preview URL:	https://pmc-20251201-docs.infrahub-sdk-python.pages.dev

View logs

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@            Coverage Diff             @@
##           stable     #673      +/-   ##
==========================================
+ Coverage   75.48%   75.80%   +0.32%     
==========================================
  Files         113      113              
  Lines        9512     9660     +148     
  Branches     1893     1473     -420     
==========================================
+ Hits         7180     7323     +143     
- Misses       1832     1841       +9     
+ Partials      500      496       -4     

Flag	Coverage Δ
integration-tests	34.53% <ø> (-0.37%)	⬇️
python-3.10	49.54% <ø> (+0.77%)	⬆️
python-3.11	49.56% <ø> (+0.79%)	⬆️
python-3.12	49.54% <ø> (+0.77%)	⬆️
python-3.13	49.54% <ø> (+0.77%)	⬆️
python-3.9	?
python-filler-3.12	24.10% <ø> (-0.19%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 26 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.