Skip to content

v1.2.0#29

Merged
LordLumineer merged 17 commits intomasterfrom
pre-release
May 15, 2025
Merged

v1.2.0#29
LordLumineer merged 17 commits intomasterfrom
pre-release

Conversation

@LordLumineer
Copy link
Contributor

@LordLumineer LordLumineer commented May 15, 2025

  • Moved the documentation to the docs folder, to be served by github pages.

  • Image Repository is now ghcr.io instead of dockerhub

  • CI/CD:

    • Reduction of automated builds of images (ref. here)
      • The tags are now automatically generated

Summary by CodeRabbit

  • New Features

    • Added automated deployment of documentation to GitHub Pages.
    • Enabled user input for the WebSocket server URL in the demo page.
    • Introduced new CI workflows for continuous integration and Docker image publishing to GitHub Container Registry (ghcr.io).
  • Bug Fixes

    • Improved error handling in the WebSocket demo to display clearer messages for connection issues.
  • Documentation

    • Moved project documentation to the docs folder for GitHub Pages.
    • Updated changelog and README to reflect recent changes and new CI status badge.
    • Removed outdated DockerHub README.
  • Refactor

    • Switched container image repository from Docker Hub to GitHub Container Registry.
    • Simplified and updated configuration files and static content serving.
  • Tests

    • Removed obsolete ping endpoint test and improved test documentation.
  • Chores

    • Cleaned up VSCode settings and updated .gitattributes for documentation detection.

* ✨ v1.0.5 - Try It Out
* Removed the bridge to the titles and cleaned so of the code

* feat: 🧪 Better CI/CD to include the pre-release branch

Invalid version on purpose to test the version validation

Invalid version on purpose to test the version validation

* run version check on pre-release PR

* Now with valid version
* feat: ✨ v1.0.5 - Try It Out

Added a box to try out the service directly in the home page

* v1.0.5 - BETA

* beta 1

* removed the bridge to the titles and cleaned so of the code

* feat: 🧪 Better CI/CD to include the pre-release branch

Invalid version on purpose to test the version validation

Invalid version on purpose to test the version validation

* run version check on pre-release PR

* Now with valid version

* beta v2 fixed homepage tags

* fix: 🐛 Fixed wrong endpoint for SEO
* ci: Check the diff of the changes.md

* ci: Fixed the if statements to check the version depending on the target of the PR
* v1.1.0 - READY

* v1.0 Stable
Added scrit.js and style.css to the gitattributes ignore (docs) as these aren't really part of the project and are there for documentation (homepage)
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 15, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This update restructures project documentation and static resources, removes static file serving and the /ping endpoint from the FastAPI app, and migrates CI/CD workflows to GitHub Actions for testing, coverage, Docker image publishing to GitHub Container Registry, and GitHub Pages deployment. It also updates meta tags, endpoint docstrings, and documentation references accordingly.

Changes

File(s) Change Summary
.github/workflows/CI.yml, .github/workflows/publish-ghcr.yml, .github/workflows/GH-pages.yml Added new GitHub Actions workflows for CI testing, Docker image publishing to ghcr.io, and GitHub Pages deployment.
.github/workflows/ci-cd.yml Deleted old CI/CD workflow handling versioning, testing, and DockerHub deployment.
.gitattributes Changed documentation file pattern from individual static files to all files in docs/.
.vscode/settings.json Simplified configuration by removing Python testing and spell-check settings.
CHANGES.md Added changelog entry for version 1.2.0, documenting documentation move and CI/CD changes.
DockerHub_ReadMe.md Deleted DockerHub-specific README.
README.md Updated CI/CD badge to reference new workflow.
app/main.py Removed static file serving and /ping endpoint; improved docstrings for /version and WebSocket endpoints; updated version to 1.2.0.
docker-compose.yml Updated Docker image reference from Docker Hub to GitHub Container Registry.
docs/index.html Updated favicon and meta tags; added input field for WebSocket server URL in demo.
docs/script.js Replaced dynamic URL construction with fixed endpoint URLs; demo allows user-specified WebSocket server URL.
tests/test_main.py Removed /ping endpoint test; enhanced docstrings for remaining tests.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocsPage
    participant WebSocketDemo
    participant FastAPIApp
    participant GitHubActions
    participant GHCR

    User->>DocsPage: Opens documentation (now in /docs)
    DocsPage->>WebSocketDemo: Loads demo script
    User->>WebSocketDemo: Enters server URL and token, connects
    WebSocketDemo->>FastAPIApp: Connects to wss://ko-fi.eventkit.stream/ws/{token}
    FastAPIApp-->>WebSocketDemo: Maintains WebSocket connection

    User->>GitHubActions: Pushes code or triggers workflow
    GitHubActions->>FastAPIApp: Runs tests, collects coverage
    GitHubActions->>GHCR: Builds and publishes Docker image
    GitHubActions->>DocsPage: Deploys docs to GitHub Pages
Loading

Poem

🐇
The docs have hopped to a brand new place,
While static files vanish without a trace.
CI now runs with a GitHub spin,
And Docker images find a new home within.
Version’s bumped, the code is neat—
This bunny’s work is quite the feat!

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 6ab3a39 and 283a835.

⛔ Files ignored due to path filters (5)
  • docs/assets/favicon.svg is excluded by !**/*.svg
  • docs/images/banner.png is excluded by !**/*.png
  • docs/images/favicon.ico is excluded by !**/*.ico
  • docs/images/icon.png is excluded by !**/*.png
  • docs/images/logo.png is excluded by !**/*.png
📒 Files selected for processing (14)
  • .gitattributes (1 hunks)
  • .github/workflows/CI.yml (1 hunks)
  • .github/workflows/GH-pages.yml (1 hunks)
  • .github/workflows/ci-cd.yml (0 hunks)
  • .github/workflows/publish-ghcr.yml (1 hunks)
  • .vscode/settings.json (1 hunks)
  • CHANGES.md (1 hunks)
  • DockerHub_ReadMe.md (0 hunks)
  • README.md (1 hunks)
  • app/main.py (3 hunks)
  • docker-compose.yml (1 hunks)
  • docs/index.html (2 hunks)
  • docs/script.js (6 hunks)
  • tests/test_main.py (2 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

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 bot added a commit that referenced this pull request May 15, 2025
Docstrings generation was requested by @LordLumineer.

* #29 (comment)

The following files were modified:

* `app/main.py`
* `tests/test_main.py`
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 15, 2025

Note

Generated docstrings for this pull request at #30

@codecov
Copy link

codecov bot commented May 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

Files with missing lines Coverage Δ
app/main.py 100.00% <ø> (ø)

Docstrings generation was requested by @LordLumineer.

* #29 (comment)

The following files were modified:

* `app/main.py`
* `tests/test_main.py`

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@LordLumineer LordLumineer merged commit 7326550 into master May 15, 2025
4 checks passed
@LordLumineer LordLumineer deleted the pre-release branch May 15, 2025 20:08
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