Document CI / CD pipelines and release workflow
juarezr opened this issue · 1 comments
juarezr commented
Problem description
- Today we have just some outdated instructions in the file release.txt
- There is no documentation about testing workflow in Github Actions, AppVeyor, travis-ci.org (discontinued)
- There is no documentation about testing workflow in Github Actions, Coveralls, PyPI, Conda-Forge, readthedocs.org
Suggestion of Roadmap
- Fix #583
- Migrate CI / CD workflows from travis-ci.org (discontinued) and AppVeyor to Github Actions
- Write documentation explaining the process.
- A simple devops.md file linked in Readme.md it's a good start
- Cleanup old, outdated, and incorrect information and files.
juarezr commented
CI / CD Documentation
Continuos Integration
Pytest
- Triggered by push, pull_request on
push
andpull_request
Coveralls
- How-To: Copveralls - Language Integration - Python
- CI Repository: petl.readthedocs.io
- Account Configuration: petl.readthedocs.io
- CI Configuration: CI step: Coveralls
- Triggered by push, pull_request on
push
andpull_request
Code Analysis
Pipelines
- Codacity: Triggered by push, pull_request
- CodeQL: Triggered by push, pull_request
Continuos Delivery
PyPI
- How-To: Publishing package distribution releases using GitHub Actions CI/CD workflows
- Package Repository: PyPI
- CD Pipeline: Github Action: publish-release
- Secret: PYPI_API_TOKEN
- Triggered by: Github Release being
published
Conda-Forge
- How-To: Using conda-smithy to manage your CI
- Package Repository: Anaconda / Conda Forge
- CD Repository: conda-forge/petl-feedstock
- Configuration: conda-smithy main recipe/meta.yml
- Triggered by: regro-ci bot after release on PyPI
readthedocs.org
- How-To: Connecting Your VCS Account - Github
- Document Repository: petl.readthedocs.io
- Account Configuration: petl.readthedocs.io
- CD Configuration: VCS Integrations - Github using requirements-docs.txt
- Triggered by: Github WebHook on
push
,pull_request
and Github Release beingpublished
Others
TODO List
- CI/CD Improvements, ToDos, and Wishlist #592
- Fix code issues found with automated code scanning #586
- Reformat Code
- Decide the best place for this documentation:
Discontinued CI / CD
travis-ci.org
- Account Configuration: travis-ci.org
- Build: History and last successfull build and release
- Triggered by: Github WebHook
AppVeyor (Windows only)
- Account Configuration: appveyor.com
- Build: History and last successfull build
- Triggered by: Github WebHook