bar-raiser

Bar-Raiser

Bar-Raiser is a cutting-edge framework designed to help engineering teams tackle technical debt, streamline development workflows, and elevate code quality.

Main Features

Create GitHub Checks for Enhanced Developer Experiences

• Simplified Results: View linter or test results in a dedicated check page, eliminating the need to sift through console output.
• Inline Annotations: View linter or test errors as annotations on GitHub Pull Requests, making it easier to understand errors in the context of the code.
• Autofix Support: Apply auto-fixes with a single click. This feature requires setting up a web service to receive GitHub webhook events and apply the autofix on the PR.
• Slack Notifications: Sends Slack notifications on check failures based on a provided mapping from GitHub login to Slack user ID. A SLACK_BOT_TOKEN and a GitHub login to Slack user ID mapping file are needed.

Examples

• Check Run Example
• File Annotations Example

Available Checks

The following checks are available and can be configured in a CI workflow e.g. build.yml file. Ensure to provide the necessary environment variables (APP_ID, PRIVATE_KEY, PULL_NUMBER, SLACK_BOT_TOKEN (optional)).

checks/annotate_ruff.py Module

• Ruff Integration: Runs Ruff formatter and linter, parses the output, and creates GitHub check runs with annotations and actions.
• Autofix Support: Provides an autofix action to automatically fix issues detected by Ruff.

checks/annotate_pytest.py Module

• Pytest Integration: Parses Pytest JSON reports and creates GitHub check runs with annotations for failed tests.

checks/annotate_pyright.py Module

• Pyright Integration: Runs Pyright type checker, parses the output, and creates GitHub check runs with annotations and actions.
• Autofix Support: Provides an autofix action to automatically fix issues detected by Pyright.

Getting Started (For Developers)

Prerequisites

• Clone the repository:

  git clone https://github.com/ZipHQ/bar-raiser.git
  

• Install PDM:

  pip install pdm
  

• Install dependencies in a local .venv folder:

  pdm install
  

• Install pre-commit hooks:

  pdm run pre-commit install
  

Dependencies

The project uses the following dependencies:

• PyGithub (MIT License): A Python library to access the GitHub API v3.
• GitPython (BSD License): A Python library used to interact with Git repositories.
• cryptography (Apache License 2.0 or BSD License): A Python library providing cryptographic recipes and primitives.
• slackclient (MIT License): A Python library for interacting with the Slack API.

Development Dependencies

The project also includes development dependencies for testing, linting, and code quality:

• pytest (MIT License): A framework that makes building simple and scalable test cases easy.
• diff-cover (MIT License): A tool for checking which lines of code are covered by tests.
• pytest-cov (MIT License): A plugin for measuring code coverage with pytest.
• ruff (MIT License): An extremely fast Python linter and formatter.
• pyright (MIT License): A static type checker for Python.
• pre-commit (MIT License): A framework for managing and maintaining multi-language pre-commit hooks.
• pytest-json-report (MIT License): A plugin for creating JSON reports with pytest.

Pre-commit Hooks

Pre-commit hooks are used to run checks automatically when you commit code. These checks help ensure code quality and consistency. The following hooks are configured:

• Trailing whitespace removal
• End-of-file fixer
• YAML file checks
• Large file checks
• PDM lock file check
• PDM sync
• Ruff for linting and formatting
• Pyright for type checking
• Pytest for running tests with coverage

To manually run the pre-commit hooks on all files, use:

pdm run pre-commit run --all-files

Running Tests

To execute the test suite, run:

pdm run pytest

API Changes

• CI Interface: The CI interface will be maintained for compatibility until the next major version release.
• Python API: The Python API is still under development, and backward compatibility may change at any time.

Contributing

• Fork the repository.
• Create a new branch (git checkout -b feature-branch).
• Make your changes.
• Commit your changes (git commit -m 'Add some feature').
• Push to the branch (git push origin feature-branch).
• Open a pull request.

Coding Standards

• Follow the existing code style.
• Write unit tests for new features.
• Ensure all tests pass before submitting a pull request.

Making a Release

To make a release, follow these steps:

• Ensure all changes are committed and pushed to the main branch.
• Create a new tag for the release:

  git tag -a vX.Y.Z -m "Release version X.Y.Z"
  git push origin vX.Y.Z
  

• The GitHub release workflow will automatically build and publish the release based on the tagged commit.

Credits

This project was developed collaboratively by the Zip Infra team. For insights into our work and ongoing updates, check out our tech blog. tech blog.