https://github.com/gjbex/ci-example

Repository to illustrate CI for software testing
https://github.com/gjbex/ci-example

continuous-integration linting quality testing training version-control

Last synced: about 1 month ago
JSON representation

Repository to illustrate CI for software testing

• Host: GitHub
• URL: https://github.com/gjbex/ci-example
• Owner: gjbex
• License: cc-by-4.0
• Created: 2024-02-12T20:33:29.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-09-06T16:46:01.000Z (4 months ago)
• Last Synced: 2024-09-06T19:54:14.338Z (4 months ago)
• Topics: continuous-integration, linting, quality, testing, training, version-control
• Language: Python
• Homepage:
• Size: 26.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CI example

Repository to illustrate

  * Continuous Integration (CI) for software development projects.

  * Using poetry to manage Python software development projects.

## What is it?

  1. `pyproject.toml`: poetry project configuration file.

  1. `poetry.lock`: poetry lock file.

  1. `ci_example`: Python source code directory.

  1. `tests`: pytest unit test for the project.

  1. `CONTRIBUTING.md`: how to contribute to this repository.

  1. `LICENSE`: license for the material in this repository.

## Note

The `main` branch of this repository passes both the `pytest` and the `mypy`

tests, however, the `development` branch of the repository has a test case that

fails intentionally to illustrate that you can prevent a pull request in such a

case.

For that reason, the `main` branch is protected, i.e., only merges through pull

requests are allowed, and the pull request has to pass the build test.