feat:semver

[JarbasAl]

closes #1

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced multiple GitHub Actions workflows to automate processes including build tests, license checks, code coverage, and release management.
  • Added versioning management in the project for better tracking of software development.

• Bug Fixes

  • Updated dependency version specifications for improved compatibility.

• Documentation

  • Removed outdated documentation files to streamline project resources.

• Tests

  • Added new testing dependencies (flake8 and pytest) to enhance code quality and testing practices.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces multiple new GitHub Actions workflow files to automate processes such as build testing, license checks, code coverage, and release management. Modifications to the setup.py file enhance dynamic version management, while updates to dependency specifications in requirements.txt improve project maintainability. Additionally, several documentation files have been deleted, indicating a potential restructuring or cleanup of the project. Overall, the changes aim to enhance automation and streamline the development workflow.

Changes

File Path	Change Summary
.github/workflows/build_tests.yml	New workflow for build testing, triggered on push and manual dispatch.
.github/workflows/conventional-label.yaml	New workflow for auto-labeling pull requests based on commit messages.
.github/workflows/coverage.yml	New workflow for running code coverage checks, triggered on pushes to dev branch.
.github/workflows/install_tests.yml	New workflow for installation tests across multiple Python versions.
.github/workflows/license_tests.yml	New workflow for automating license compliance checks.
.github/workflows/publish_stable.yml	New workflow for automating the stable release process to PyPI.
.github/workflows/release_workflow.yml	New workflow for automating the release process for alpha versions.
.github/workflows/unit_tests.yml	New workflow for running unit tests across multiple Python versions.
demo.py	Deleted file containing a sample program for testing.
docs/.gitignore	Deleted file specifying ignored directories for version control.
docs/Makefile	Deleted minimal makefile for building Sphinx documentation.
docs/conf.py	Deleted Sphinx configuration file for documentation.
docs/index.rst	Deleted documentation file for the Padatious library.
ovos_padatious/version.py	New versioning block added to manage software versioning.
requirements.txt	Updated version constraint for ovos-plugin-manager.
setup.py	Modifications for dynamic version management and refactored requirement handling.
tests/requirements.txt	Added dependencies flake8 and pytest for code quality and testing.

Assessment against linked issues

Objective	Addressed	Explanation
Automate publishing to PyPI (#1)	✅

Possibly related PRs

• feat/opm_pipeline #2: The changes in requirements.txt regarding the ovos-plugin-manager dependency are relevant as they may impact the build process defined in the build_tests.yml workflow, ensuring that the necessary plugin manager is available for the project.

Suggested labels

packaging, refactor

Poem

In the burrow deep, where the code does flow,
New workflows sprout, like springtime's glow.
Automate the tasks, let the bunnies play,
With tests and builds, we'll hop all day!
From PyPI to coverage, our efforts align,
In the garden of code, everything's fine! 🐇✨

---

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