Freqtrade CI #3
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Freqtrade CI | |
| on: | |
| push: | |
| branches: | |
| - stable | |
| - develop | |
| - ci/* | |
| tags: | |
| release: | |
| types: [published] | |
| pull_request: | |
| schedule: | |
| - cron: '0 3 * * 4' | |
| concurrency: | |
| group: "${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}" | |
| cancel-in-progress: true | |
| permissions: | |
| repository-projects: read | |
| jobs: | |
| build-linux: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ "ubuntu-20.04", "ubuntu-22.04", "ubuntu-24.04" ] | |
| python-version: ["3.9", "3.10", "3.11", "3.12"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Cache_dependencies | |
| uses: actions/cache@v4 | |
| id: cache | |
| with: | |
| path: ~/dependencies/ | |
| key: ${{ runner.os }}-dependencies | |
| - name: pip cache (linux) | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/pip | |
| key: test-${{ matrix.os }}-${{ matrix.python-version }}-pip | |
| - name: TA binary *nix | |
| if: steps.cache.outputs.cache-hit != 'true' | |
| run: | | |
| cd build_helpers && ./install_ta-lib.sh ${HOME}/dependencies/; cd .. | |
| - name: Installation - *nix | |
| run: | | |
| python -m pip install --upgrade "pip<=24.0" wheel | |
| export LD_LIBRARY_PATH=${HOME}/dependencies/lib:$LD_LIBRARY_PATH | |
| export TA_LIBRARY_PATH=${HOME}/dependencies/lib | |
| export TA_INCLUDE_PATH=${HOME}/dependencies/include | |
| pip install -r requirements-dev.txt | |
| pip install -e ft_client/ | |
| pip install -e . | |
| - name: Check for version alignment | |
| run: | | |
| python build_helpers/freqtrade_client_version_align.py | |
| - name: Tests | |
| run: | | |
| pytest --random-order --cov=freqtrade --cov=freqtrade_client --cov-config=.coveragerc | |
| - name: Coveralls | |
| if: (runner.os == 'Linux' && matrix.python-version == '3.10' && matrix.os == 'ubuntu-22.04') | |
| env: | |
| # Coveralls token. Not used as secret due to github not providing secrets to forked repositories | |
| COVERALLS_REPO_TOKEN: 6D1m0xupS3FgutfuGao8keFf9Hc0FpIXu | |
| run: | | |
| # Allow failure for coveralls | |
| coveralls || true | |
| - name: Check for repository changes | |
| run: | | |
| if [ -n "$(git status --porcelain)" ]; then | |
| echo "Repository is dirty, changes detected:" | |
| git status | |
| git diff | |
| exit 1 | |
| else | |
| echo "Repository is clean, no changes detected." | |
| fi | |
| - name: Backtesting (multi) | |
| run: | | |
| cp tests/testdata/config.tests.json config.json | |
| freqtrade create-userdir --userdir user_data | |
| freqtrade new-strategy -s AwesomeStrategy | |
| freqtrade new-strategy -s AwesomeStrategyMin --template minimal | |
| freqtrade backtesting --datadir tests/testdata --strategy-list AwesomeStrategy AwesomeStrategyMin -i 5m | |
| - name: Hyperopt | |
| run: | | |
| cp tests/testdata/config.tests.json config.json | |
| freqtrade create-userdir --userdir user_data | |
| freqtrade hyperopt --datadir tests/testdata -e 6 --strategy SampleStrategy --hyperopt-loss SharpeHyperOptLossDaily --print-all | |
| - name: Sort imports (isort) | |
| run: | | |
| isort --check . | |
| - name: Run Ruff | |
| run: | | |
| ruff check --output-format=github | |
| - name: Run Ruff format check | |
| run: | | |
| ruff format --check | |
| - name: Mypy | |
| run: | | |
| mypy freqtrade scripts tests | |
| - name: Discord notification | |
| uses: rjstone/discord-webhook-notify@v1 | |
| if: failure() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false) | |
| with: | |
| severity: error | |
| details: Freqtrade CI failed on ${{ matrix.os }} | |
| webhookUrl: ${{ secrets.DISCORD_WEBHOOK }} | |
| build-macos: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ "macos-12", "macos-13", "macos-14" ] | |
| python-version: ["3.9", "3.10", "3.11", "3.12"] | |
| exclude: | |
| - os: "macos-14" | |
| python-version: "3.9" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| check-latest: true | |
| - name: Cache_dependencies | |
| uses: actions/cache@v4 | |
| id: cache | |
| with: | |
| path: ~/dependencies/ | |
| key: ${{ matrix.os }}-dependencies | |
| - name: pip cache (macOS) | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/Library/Caches/pip | |
| key: ${{ matrix.os }}-${{ matrix.python-version }}-pip | |
| - name: TA binary *nix | |
| if: steps.cache.outputs.cache-hit != 'true' | |
| run: | | |
| cd build_helpers && ./install_ta-lib.sh ${HOME}/dependencies/; cd .. | |
| - name: Installation - macOS (Brew) | |
| run: | | |
| # brew update | |
| # TODO: Should be the brew upgrade | |
| # homebrew fails to update python due to unlinking failures | |
| # https://github.com/actions/runner-images/issues/6817 | |
| rm /usr/local/bin/2to3 || true | |
| rm /usr/local/bin/2to3-3.11 || true | |
| rm /usr/local/bin/2to3-3.12 || true | |
| rm /usr/local/bin/idle3 || true | |
| rm /usr/local/bin/idle3.11 || true | |
| rm /usr/local/bin/idle3.12 || true | |
| rm /usr/local/bin/pydoc3 || true | |
| rm /usr/local/bin/pydoc3.11 || true | |
| rm /usr/local/bin/pydoc3.12 || true | |
| rm /usr/local/bin/python3 || true | |
| rm /usr/local/bin/python3.11 || true | |
| rm /usr/local/bin/python3.12 || true | |
| rm /usr/local/bin/python3-config || true | |
| rm /usr/local/bin/python3.11-config || true | |
| rm /usr/local/bin/python3.12-config || true | |
| brew install hdf5 c-blosc libomp | |
| - name: Installation (python) | |
| run: | | |
| python -m pip install --upgrade "pip<=24.0" wheel | |
| export LD_LIBRARY_PATH=${HOME}/dependencies/lib:$LD_LIBRARY_PATH | |
| export TA_LIBRARY_PATH=${HOME}/dependencies/lib | |
| export TA_INCLUDE_PATH=${HOME}/dependencies/include | |
| pip install -r requirements-dev.txt | |
| pip install -e ft_client/ | |
| pip install -e . | |
| - name: Tests | |
| run: | | |
| pytest --random-order | |
| - name: Check for repository changes | |
| run: | | |
| if [ -n "$(git status --porcelain)" ]; then | |
| echo "Repository is dirty, changes detected:" | |
| git status | |
| git diff | |
| exit 1 | |
| else | |
| echo "Repository is clean, no changes detected." | |
| fi | |
| - name: Backtesting | |
| run: | | |
| cp tests/testdata/config.tests.json config.json | |
| freqtrade create-userdir --userdir user_data | |
| freqtrade new-strategy -s AwesomeStrategyAdv --template advanced | |
| freqtrade backtesting --datadir tests/testdata --strategy AwesomeStrategyAdv | |
| - name: Hyperopt | |
| run: | | |
| cp tests/testdata/config.tests.json config.json | |
| freqtrade create-userdir --userdir user_data | |
| freqtrade hyperopt --datadir tests/testdata -e 5 --strategy SampleStrategy --hyperopt-loss SharpeHyperOptLossDaily --print-all | |
| - name: Sort imports (isort) | |
| run: | | |
| isort --check . | |
| - name: Run Ruff | |
| run: | | |
| ruff check --output-format=github | |
| - name: Run Ruff format check | |
| run: | | |
| ruff format --check | |
| - name: Mypy | |
| run: | | |
| mypy freqtrade scripts | |
| - name: Discord notification | |
| uses: rjstone/discord-webhook-notify@v1 | |
| if: failure() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false) | |
| with: | |
| severity: info | |
| details: Test Succeeded! | |
| webhookUrl: ${{ secrets.DISCORD_WEBHOOK }} | |
| build-windows: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ windows-latest ] | |
| python-version: ["3.9", "3.10", "3.11", "3.12"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Pip cache (Windows) | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~\AppData\Local\pip\Cache | |
| key: ${{ matrix.os }}-${{ matrix.python-version }}-pip | |
| - name: Installation | |
| run: | | |
| ./build_helpers/install_windows.ps1 | |
| - name: Tests | |
| run: | | |
| pytest --random-order | |
| - name: Check for repository changes | |
| run: | | |
| if (git status --porcelain) { | |
| Write-Host "Repository is dirty, changes detected:" | |
| git status | |
| git diff | |
| exit 1 | |
| } | |
| else { | |
| Write-Host "Repository is clean, no changes detected." | |
| } | |
| - name: Backtesting | |
| run: | | |
| cp tests/testdata/config.tests.json config.json | |
| freqtrade create-userdir --userdir user_data | |
| freqtrade backtesting --datadir tests/testdata --strategy SampleStrategy | |
| - name: Hyperopt | |
| run: | | |
| cp tests/testdata/config.tests.json config.json | |
| freqtrade create-userdir --userdir user_data | |
| freqtrade hyperopt --datadir tests/testdata -e 5 --strategy SampleStrategy --hyperopt-loss SharpeHyperOptLossDaily --print-all | |
| - name: Run Ruff | |
| run: | | |
| ruff check --output-format=github | |
| - name: Run Ruff format check | |
| run: | | |
| ruff format --check | |
| - name: Mypy | |
| run: | | |
| mypy freqtrade scripts tests | |
| - name: Run Pester tests (PowerShell) | |
| run: | | |
| $PSVersionTable | |
| Set-PSRepository psgallery -InstallationPolicy trusted | |
| Install-Module -Name Pester -RequiredVersion 5.3.1 -Confirm:$false -Force -SkipPublisherCheck | |
| $Error.clear() | |
| Invoke-Pester -Path "tests" -CI | |
| if ($Error.Length -gt 0) {exit 1} | |
| shell: powershell | |
| - name: Discord notification | |
| uses: rjstone/discord-webhook-notify@v1 | |
| if: failure() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false) | |
| with: | |
| severity: error | |
| details: Test Failed | |
| webhookUrl: ${{ secrets.DISCORD_WEBHOOK }} | |
| mypy-version-check: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: pre-commit dependencies | |
| run: | | |
| pip install pyaml | |
| python build_helpers/pre_commit_update.py | |
| pre-commit: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - uses: pre-commit/[email protected] | |
| docs-check: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Documentation syntax | |
| run: | | |
| ./tests/test_docs.sh | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Documentation build | |
| run: | | |
| pip install -r docs/requirements-docs.txt | |
| pip install mkdocs | |
| mkdocs build | |
| - name: Discord notification | |
| uses: rjstone/discord-webhook-notify@v1 | |
| if: failure() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false) | |
| with: | |
| severity: error | |
| details: Freqtrade doc test failed! | |
| webhookUrl: ${{ secrets.DISCORD_WEBHOOK }} | |
| build-linux-online: | |
| # Run pytest with "live" checks | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Cache_dependencies | |
| uses: actions/cache@v4 | |
| id: cache | |
| with: | |
| path: ~/dependencies/ | |
| key: ${{ runner.os }}-dependencies | |
| - name: pip cache (linux) | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/pip | |
| key: test-${{ matrix.os }}-${{ matrix.python-version }}-pip | |
| - name: TA binary *nix | |
| if: steps.cache.outputs.cache-hit != 'true' | |
| run: | | |
| cd build_helpers && ./install_ta-lib.sh ${HOME}/dependencies/; cd .. | |
| - name: Installation - *nix | |
| run: | | |
| python -m pip install --upgrade "pip<=24.0" wheel | |
| export LD_LIBRARY_PATH=${HOME}/dependencies/lib:$LD_LIBRARY_PATH | |
| export TA_LIBRARY_PATH=${HOME}/dependencies/lib | |
| export TA_INCLUDE_PATH=${HOME}/dependencies/include | |
| pip install -r requirements-dev.txt | |
| pip install -e ft_client/ | |
| pip install -e . | |
| - name: Tests incl. ccxt compatibility tests | |
| env: | |
| CI_WEB_PROXY: http://152.67.78.211:13128 | |
| run: | | |
| pytest --random-order --longrun --durations 20 -n auto | |
| # Notify only once - when CI completes (and after deploy) in case it's successful | |
| notify-complete: | |
| needs: [ | |
| build-linux, | |
| build-macos, | |
| build-windows, | |
| docs-check, | |
| mypy-version-check, | |
| pre-commit, | |
| build-linux-online | |
| ] | |
| runs-on: ubuntu-22.04 | |
| # Discord notification can't handle schedule events | |
| if: github.event_name != 'schedule' && github.repository == 'freqtrade/freqtrade' | |
| permissions: | |
| repository-projects: read | |
| steps: | |
| - name: Check user permission | |
| id: check | |
| uses: scherermichael-oss/[email protected] | |
| with: | |
| required-permission: write | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Discord notification | |
| uses: rjstone/discord-webhook-notify@v1 | |
| if: always() && steps.check.outputs.has-permission && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false) | |
| with: | |
| severity: info | |
| details: Test Completed! | |
| webhookUrl: ${{ secrets.DISCORD_WEBHOOK }} | |
| build: | |
| name: "Build" | |
| needs: [ build-linux, build-macos, build-windows, docs-check, mypy-version-check, pre-commit ] | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Build distribution | |
| run: | | |
| pip install -U build | |
| python -m build --sdist --wheel | |
| - name: Upload artifacts 📦 | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: freqtrade-build | |
| path: | | |
| dist | |
| retention-days: 10 | |
| - name: Build Client distribution | |
| run: | | |
| pip install -U build | |
| python -m build --sdist --wheel ft_client | |
| - name: Upload artifacts 📦 | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: freqtrade-client-build | |
| path: | | |
| ft_client/dist | |
| retention-days: 10 | |
| deploy-pypi: | |
| name: "Deploy to PyPI" | |
| needs: [ build ] | |
| runs-on: ubuntu-22.04 | |
| if: (github.event_name == 'release') | |
| environment: | |
| name: release | |
| url: https://pypi.org/p/freqtrade | |
| permissions: | |
| id-token: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Download artifact 📦 | |
| uses: actions/download-artifact@v4 | |
| with: | |
| pattern: freqtrade*-build | |
| path: dist | |
| merge-multiple: true | |
| - name: Publish to PyPI (Test) | |
| uses: pypa/[email protected] | |
| with: | |
| repository-url: https://test.pypi.org/legacy/ | |
| - name: Publish to PyPI | |
| uses: pypa/[email protected] | |
| deploy-docker: | |
| needs: [ build-linux, build-macos, build-windows, docs-check, mypy-version-check, pre-commit ] | |
| runs-on: ubuntu-22.04 | |
| if: (github.event_name == 'push' || github.event_name == 'schedule' || github.event_name == 'release') && github.repository == 'freqtrade/freqtrade' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Extract branch name | |
| id: extract-branch | |
| run: | | |
| echo "GITHUB_REF='${GITHUB_REF}'" | |
| echo "branch=${GITHUB_REF##*/}" >> "$GITHUB_OUTPUT" | |
| - name: Dockerhub login | |
| env: | |
| DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }} | |
| DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} | |
| run: | | |
| echo "${DOCKER_PASSWORD}" | docker login --username ${DOCKER_USERNAME} --password-stdin | |
| # We need docker experimental to pull the ARM image. | |
| - name: Switch docker to experimental | |
| run: | | |
| docker version -f '{{.Server.Experimental}}' | |
| echo $'{\n "experimental": true\n}' | sudo tee /etc/docker/daemon.json | |
| sudo systemctl restart docker | |
| docker version -f '{{.Server.Experimental}}' | |
| - name: Set up QEMU | |
| uses: docker/setup-qemu-action@v3 | |
| - name: Set up Docker Buildx | |
| id: buildx | |
| uses: docker/setup-buildx-action@v3 | |
| - name: Available platforms | |
| run: echo ${{ steps.buildx.outputs.platforms }} | |
| - name: Build and test and push docker images | |
| env: | |
| BRANCH_NAME: ${{ steps.extract-branch.outputs.branch }} | |
| run: | | |
| build_helpers/publish_docker_multi.sh | |
| deploy-arm: | |
| name: "Deploy Docker" | |
| permissions: | |
| packages: write | |
| needs: [ deploy-docker ] | |
| # Only run on 64bit machines | |
| runs-on: [self-hosted, linux, ARM64] | |
| if: (github.event_name == 'push' || github.event_name == 'schedule' || github.event_name == 'release') && github.repository == 'freqtrade/freqtrade' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Extract branch name | |
| id: extract-branch | |
| run: | | |
| echo "GITHUB_REF='${GITHUB_REF}'" | |
| echo "branch=${GITHUB_REF##*/}" >> "$GITHUB_OUTPUT" | |
| - name: Dockerhub login | |
| env: | |
| DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }} | |
| DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} | |
| run: | | |
| echo "${DOCKER_PASSWORD}" | docker login --username ${DOCKER_USERNAME} --password-stdin | |
| - name: Build and test and push docker images | |
| env: | |
| BRANCH_NAME: ${{ steps.extract-branch.outputs.branch }} | |
| GHCR_USERNAME: ${{ github.actor }} | |
| GHCR_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| build_helpers/publish_docker_arm64.sh | |
| - name: Discord notification | |
| uses: rjstone/discord-webhook-notify@v1 | |
| if: always() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false) && (github.event_name != 'schedule') | |
| with: | |
| severity: info | |
| details: Deploy Succeeded! | |
| webhookUrl: ${{ secrets.DISCORD_WEBHOOK }} |