-
(Optional) Clear virtual machine of old requirements:
pip uninstall -y -r <(pip freeze)
-
(Optional) Check
requirements.txt
andrequirement-dev.txt
for latest dependency versions. -
(Optional) Update virtual machine with the latest dependencies:
pip install -r requirements.txt -r requirements-dev.txt
-
(Optional) Lint code with
flake8
:flake8 . --count --show-source --statistics
-
(Optional) Check code security with
bandit
:bandit -r .
-
(Optional) Run all
pytest
tests:python -m pytest
-
(Optional) Run all
pytest
tests verbosely:python -m pytest -v -s
-
(Optional) Test Python support using act for GitHub Actions:
act -j build
Note: If
act
is unable to locate Docker, make sure that the required/var/run/docker.sock
symlink exists. If it does not, you can fix it by running:sudo ln -s "$HOME/.docker/run/docker.sock" /var/run/docker.sock`
-
Update the Docker
compose.yaml
file with the latest version of the app. -
Build and push a new Docker image for the app (see DEPLOYMENT.md).
-
(Optional) Create a new git branch if creating a release:
git checkout -b release/vX.X.X
-
Create a git commit:
git add . git commit -m 'commit message'
-
Update the git tag (format:
git tag -a [tag_name/version] -m [message]
):git tag -a v1.0.0 -m 'first release' git push origin --tags
-
(Optional) View git tags:
git tag -l --sort=v:refname -n99
-
Update
fantasy-football-metrics-weekly-report
GitHub repository:-
(Optional) If creating a release:
git push -u origin release/vX.X.X
-
If updating
main
:git push
-
-
Open a pull request (PR) with the
release/vX.X.X
branch, allow GitHub actions to complete successfully, draft release notes, and merge it. -
Go to the FFMWR Releases page and draft a new release using the above git tag.