feat(GH-881): schema diagram generation

[ThomasAFink]

Pull Request Checklist (Feature Branch to next):

• Ich habe die neuesten Änderungen aus dem next Branch in meinen Feature-Branch gemergt.
• Das Code-Review wurde abgeschlossen.
• Fachliche Tests wurden durchgeführt und sind abgeschlossen.

Summary by CodeRabbit

• New Features

  • Enhanced deployment traceability by displaying dynamic links with branch and commit details on published pages.

• Style

  • Updated the footer design and adjusted hyperlink paths for improved visual consistency and navigation reliability.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes add two new parameters—git_commit and git_branch—to GitHub Actions workflows. In the combined workflow, these parameters are automatically set to ${{ github.sha }} and ${{ github.ref_name }} respectively. In the deploy-pages workflow, the parameters are introduced as required string inputs. Additionally, the deploy-pages workflow now generates an HTML index page with a dynamic footer that displays links to the specific branch and commit used in the deployment, along with minor corrections to schema diagram links.

Changes

File(s)	Change Summary
.github/workflows/combined-workflow-with-docs.yaml .github/workflows/deploy-pages.yaml	Added new parameters git_commit and git_branch (set from ${{ github.sha }} and ${{ github.ref_name }} in one workflow; defined as required string inputs in the other) to capture commit and branch information.
.github/workflows/deploy-pages.yaml	Introduced a dynamic footer in the generated HTML index page that displays links for the branch and commit, and corrected links for schema diagrams.

Sequence Diagram(s)

sequenceDiagram
    participant Trigger as Git Trigger
    participant Workflow as GitHub Workflow
    participant Deploy as deploy-to-pages Job
    Trigger->>Workflow: Trigger workflow event
    Workflow->>Deploy: Set git_commit (${'{'}{ '{'} github.sha { '}' }{ '}'}) and git_branch (${'{'}{ '{'} github.ref_name { '}' }{ '}'})
    Deploy->>Pages: Deploy content with commit/branch data

Loading

sequenceDiagram
    participant Workflow as GitHub Workflow
    participant Deploy as deploy-pages Job
    participant HTML as HTML Generator
    Workflow->>Deploy: Provide inputs (git_commit, git_branch)
    Deploy->>HTML: Generate HTML index page with dynamic footer links
    HTML->>User: Serve webpage with commit and branch details

Loading

Poem

I hopped through lines of code with glee,
Adding git details for all to see,
Parameters now guide each deploy,
Footers and links bring extra joy,
I’m a rabbit, coding light and free,
Celebrating changes with a happy 🥕 spree!

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bea2a98 and 4e248e6.

📒 Files selected for processing (2)

• .github/workflows/combined-workflow-with-docs.yaml (1 hunks)
• .github/workflows/deploy-pages.yaml (4 hunks)

---

🪧 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.