Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

semver #5

Merged
merged 1 commit into from
Feb 7, 2025
Merged

semver #5

merged 1 commit into from
Feb 7, 2025

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Feb 7, 2025

Summary by CodeRabbit

  • New Features
    • Introduced automated workflows that streamline the build, test, and release processes, ensuring more reliable package deployment and faster updates.
    • Enhanced release automation with improved notifications and release proposals.
  • Chores
    • Updated licensing information.
    • Improved version management and dependency handling for dynamic package setup.

@JarbasAl JarbasAl merged commit 826c6ef into dev Feb 7, 2025
1 check failed
Copy link

coderabbitai bot commented Feb 7, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces multiple new GitHub Actions workflows to automate CI/CD tasks such as building and testing packages, labeling pull requests, managing stable releases, and automating the release process for development branches. In addition, the package’s setup script has been enhanced with dynamic version retrieval and requirement reading, and a versioning module now defines version constants. The LICENSE file’s copyright year was updated accordingly.

Changes

File(s) Change Summary
.github/workflows/build_tests.yml
.github/workflows/conventional-label.yml
.github/workflows/publish_stable.yml
.github/workflows/release_workflow.yml
Added new GitHub Actions workflows:
- build_tests: builds and installs the package on push events.
- conventional-label: auto-labels pull requests based on commit message conventions.
- publish_stable: automates stable releases, publishing to Test PyPI and syncing branches.
- release_workflow: manages alpha releases, notifications, and PR proposals.
LICENSE Updated the copyright year from "2023 Casimiro Ferreira" to "2025 Casimiro Ferreira."
hm_matrix_bridge/version.py Added version constants: VERSION_MAJOR, VERSION_MINOR, VERSION_BUILD, and VERSION_ALPHA (all initialized to 0) for streamlined version management.
setup.py Enhanced setup functionality by introducing a BASEDIR variable, dynamic version retrieval via the new get_version() function, and dynamic dependency processing through the required() function. The package’s long description now reads from README.md, and install_requires and version parameters have been updated accordingly.

Sequence Diagram(s)

sequenceDiagram
  participant Dev as Developer
  participant GH as GitHub
  participant WL as Release Workflow
  participant EA as External Automation
  participant MX as Matrix Channel
  participant TP as Test PyPI
  participant API as GitHub API
  
  Dev->>GH: Merge PR on dev branch
  GH->>WL: Trigger release_workflow
  WL->>EA: Execute publish_alpha for alpha release
  EA-->>WL: Alpha release successful
  WL->>MX: Send notification via notify job
  WL->>WL: Run publish_pypi (build & publish to Test PyPI)
  WL->>TP: Publish package
  WL->>API: Initiate propose_release (create release PR)
  API-->>WL: PR created for stable release
Loading
sequenceDiagram
  participant Dev as Developer
  participant GH as GitHub
  participant WL as Publish Stable Workflow
  participant EA as External Automation
  participant PY as Test PyPI
  participant Sync as Sync Job
  
  Dev->>GH: Push commit to master
  GH->>WL: Trigger publish_stable workflow
  WL->>EA: Run publish_stable job (external workflow call)
  EA-->>WL: Stable release prepared
  WL->>WL: Execute publish_pypi job (checkout dev, build packages)
  WL->>PY: Publish package to Test PyPI
  WL->>Sync: Run sync_dev to update dev branch
Loading

Poem

I'm a hopping rabbit with code in my heart,
Workflows and versions—a true work of art.
I build, test, and label with a joyful spring,
Releasing magic from every new thing.
With carrots and code, I celebrate tonight!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9fb0aea and 1ddda8c.

📒 Files selected for processing (7)
  • .github/workflows/build_tests.yml (1 hunks)
  • .github/workflows/conventional-label.yml (1 hunks)
  • .github/workflows/publish_stable.yml (1 hunks)
  • .github/workflows/release_workflow.yml (1 hunks)
  • LICENSE (1 hunks)
  • hm_matrix_bridge/version.py (1 hunks)
  • setup.py (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

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.

@JarbasAl JarbasAl deleted the semver branch February 7, 2025 14:26
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