Skip to content

fix(ci): remove unsupported docs-directory input from mkdocs workflow#111

Merged
Sewer56 merged 1 commit intomainfrom
fix-mkdocs
Apr 24, 2026
Merged

fix(ci): remove unsupported docs-directory input from mkdocs workflow#111
Sewer56 merged 1 commit intomainfrom
fix-mkdocs

Conversation

@Sewer56
Copy link
Copy Markdown
Member

@Sewer56 Sewer56 commented Apr 24, 2026

The Reloaded-Project/devops-mkdocs@v1 action no longer accepts docs-directory as an input, causing CI to fail with exit code 2.

Changes:

  • Remove docs-directory: docs (unsupported input)
  • Add config-file: docs/mkdocs.yml so action finds the config file

The mkdocs config already specifies docs_dir: src, which MkDocs reads natively. No separate docs-directory input needed.

Fixes CI failure: https://github.com/Sewer56/llm-coding-tools/actions/runs/24905428630/job/72941300236

The devops-mkdocs action v1 no longer accepts docs-directory.
Added config-file: docs/mkdocs.yml so the action finds the config,
which already contains docs_dir: src for the docs directory.
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.98%. Comparing base (ceb46b6) to head (f1297b4).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #111   +/-   ##
=======================================
  Coverage   80.98%   80.98%           
=======================================
  Files         110      110           
  Lines        4517     4517           
=======================================
  Hits         3658     3658           
  Misses        859      859           
Flag Coverage Δ
async 80.22% <ø> (ø)
blocking 58.12% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 24, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 80ff5305-df1c-4e63-8bb8-116ff3020c77

📥 Commits

Reviewing files that changed from the base of the PR and between ceb46b6 and f1297b4.

📒 Files selected for processing (1)
  • .github/workflows/deploy-mkdocs.yml
📜 Recent review details
⏰ 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). (12)
  • GitHub Check: Semver Checks (Core Blocking)
  • GitHub Check: Semver Checks (Core Blocking+Linux)
  • GitHub Check: Semver Checks (Core Async+Linux)
  • GitHub Check: Semver Checks (Serdesai Full)
  • GitHub Check: Semver Checks (Serdesai Full+Linux)
  • GitHub Check: Semver Checks (Core Async)
  • GitHub Check: Async Linux
  • GitHub Check: Blocking Linux
  • GitHub Check: Blocking Windows
  • GitHub Check: Async macOS
  • GitHub Check: Async Windows
  • GitHub Check: Blocking macOS
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-04-05T18:58:45.211Z
Learnt from: Sewer56
Repo: Sewer56/llm-coding-tools PR: 85
File: .github/workflows/rust.yml:188-199
Timestamp: 2026-04-05T18:58:45.211Z
Learning: In this repository, do not treat the GitHub Actions reference `Reloaded-Project/devops-cargo-semver-checks-actionv1` as an invalid/non-existent action. It is a legitimate custom wrapper owned by `Sewer56/Reloaded-Project`, so reviews should not suggest replacing it with `obi1kenobi/cargo-semver-checks-actionv2` due to presumed non-existence.

Applied to files:

  • .github/workflows/deploy-mkdocs.yml
🔇 Additional comments (1)
.github/workflows/deploy-mkdocs.yml (1)

21-21: LGTM — config-file is the correct input for this action.

The action defines config-file (not docs-directory) as the parameter to override the default mkdocs.yml location. Pointing it at docs/mkdocs.yml correctly replaces the removed docs-directory input. Since docs/mkdocs.yml sets docs_dir: src (relative to the config file → docs/src), MkDocs will resolve the documentation source directory correctly. The existing paths: ["docs/**"] filter still covers both the config and source markdown.


Walkthrough

The .github/workflows/deploy-mkdocs.yml workflow file is updated with a modification to the MkDocs deployment action configuration. The change adds an explicit MkDocs configuration file path parameter pointing to docs/mkdocs.yml while removing the previous docs-directory input parameter. This modification shifts how the action determines the documentation content location from using a directory parameter to using the configuration file path for this determination.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix(ci): remove unsupported docs-directory input from mkdocs workflow' directly and specifically describes the main change in the pull request.
Description check ✅ Passed The description clearly explains the problem, changes made, and includes a reference to the CI failure being fixed, meeting the intent of the template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-mkdocs

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

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

@Sewer56 Sewer56 merged commit 772c967 into main Apr 24, 2026
21 checks passed
@Sewer56 Sewer56 deleted the fix-mkdocs branch April 24, 2026 20:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant