ci: restore docs/cli/zetacored/cli.md and improve file generation action

[lumtis]

Description

Closes #3382

The file was removed in #2863.

This PR also adds a fix in the file generation action to detect file deletion for generate. CI fails if the file is not present.

Summary by CodeRabbit

• Chores
  • Updated GitHub Actions workflow to improve change detection for generated files
  • Enhanced error handling to detect all types of uncommitted changes, including deletions

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The pull request modifies the GitHub Actions workflow file .github/workflows/generate-files.yml, specifically updating the change detection mechanism. The new implementation replaces the previous git diff approach with a more comprehensive git status --porcelain check. This change broadens the scope of detecting uncommitted changes, including file deletions, to ensure the generated files are thoroughly validated during the CI process.

Changes

File	Change Summary
.github/workflows/generate-files.yml	Updated change detection logic from git diff to git status --porcelain to capture a broader range of file modifications

Assessment against linked issues

Objective	Addressed	Explanation
Investigate zetacored/cli.md generation [#3382]	❓	The workflow change does not directly address the root cause of the file generation

Suggested reviewers

• gartnera
• skosito
• kingpinXD

The modifications enhance the workflow's change detection capabilities, providing a more robust mechanism for identifying uncommitted file changes during the CI process.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9fc89e0 and 7a2f457.

📒 Files selected for processing (1)

• .github/workflows/generate-files.yml (1 hunks)

🧰 Additional context used

🪛 yamllint (1.35.1)

.github/workflows/generate-files.yml

[error] 37-37: no new line character at the end of file

(new-line-at-end-of-file)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: build-zetanode
• GitHub Check: build-and-test
• GitHub Check: lint
• GitHub Check: gosec
• GitHub Check: build
• GitHub Check: Analyze (go)

🔇 Additional comments (1)

.github/workflows/generate-files.yml (1)

34-35: Excellent improvement to change detection!

The switch from git diff to git status --porcelain is a robust enhancement that will now properly detect all types of changes, including file deletions. This directly addresses the issue mentioned in #3382.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.40%. Comparing base (ac3b447) to head (ff82a65).
Report is 3 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3397   +/-   ##
========================================
  Coverage    63.40%   63.40%           
========================================
  Files          436      436           
  Lines        30690    30690           
========================================
  Hits         19460    19460           
  Misses       10394    10394           
  Partials       836      836