Jumeaux
Check difference between two responses of API.
π Documentation
https://tadashi-aikawa.github.io/jumeaux/
There is a π₯demo, too.
π¦ Install
See quick start in documentation.
π» For developer
Requirements
- poetry
- make
Flow
- Development on master and if you need branches and issues, create them
- Commit with prefix emoji such as "π", and suffix issue number like "#120"
Commands
Create environment
$ poetry env use <path of python 3.8>
$ poetry install
Run
$ poetry run python jumeaux/main.py <args>
Serve docs
$ make serve-docs
Unit test
$ make test
Integration test
$ make test-e2e
π¦ Release
1. Update release note (mkdocs/ja/releases/*)
$ git commit -m "π Update release note"
$ git push
2. Release with GitHub Actions
https://github.com/tadashi-aikawa/jumeaux/actions?query=workflow%3ARelease
(Appendix) Another way
If you can't or don't want to use GitHub Actions, you can release locally as following.
(a1) Requirements
- Windows is not supported!!!
- poetry (with pypi authentications)
- make
(a2) Commands
make release version=x.y.z
π« Licence
MIT
This software is released under the MIT License, see LICENSE.txt.