ci(workflow): improve commit message for updated documentation

[ccamel]

Self explanatory.

Summary by CodeRabbit

• Documentation
  • Improved clarity in commit messages and branch naming for documentation updates, incorporating repository details for better traceability.

[coderabbitai]

Walkthrough

This update enhances the process of updating versioned documentation by refining the commit messages and branch naming conventions. It aims to make the documentation updates more organized and traceable by including repository-specific information in commit messages and adopting a more structured approach to branch names.

Changes

Files	Change Summary
.github/workflows/.../update-versioned-docs.yml	Updated commit messages and branch names for documentation updates.

🐇✨
In the land of code and sun,
Changes made, the deed is done.
Branches named with care, you see,
Messages clear as they can be.
A rabbit hopped, left marks in sand,
"To better docs," was the command.
🌟📜

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>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e0f1876 and 85222df.

Files selected for processing (1)

• .github/workflows/update-versioned-docs.yml (1 hunks)

Additional comments: 3

.github/workflows/update-versioned-docs.yml (3)

• 89-89: The updated commit message format now includes the repository name, which enhances clarity and context. This is a positive change as it makes the commit history more informative, especially when managing documentation across multiple repositories.
• 95-95: Similarly, the commit message for creating a pull request has been updated to include the repository name. This change aligns with the objective of making commit messages more descriptive and useful for tracking documentation updates.
• 98-98: The change in branch naming convention from docs/ to feat/ suggests a reclassification of documentation updates as features. While this could align with the project's versioning strategy, it's important to ensure that this change is communicated and agreed upon by the team to maintain workflow consistency.

[amimart]

Nice catch !

[bot-anik]

Device	URL
desktop	http://localhost:3000/

Device	URL
mobile	http://localhost:3000/

Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead