Merge pull request #116 from FragileTech/docs #307
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: Push | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| branches: | |
| - master | |
| env: | |
| PROJECT_NAME: plangym | |
| PROJECT_DIR: src/plangym | |
| VERSION_FILE: src/plangym/version.py | |
| DEFAULT_BRANCH: master | |
| BOT_NAME: fragile-bot | |
| BOT_EMAIL: [email protected] | |
| DOCKER_ORG: fragiletech | |
| LOCAL_CACHE: | | |
| ~/.local/bin | |
| ~/.local/lib/python3.*/site-packages | |
| jobs: | |
| style-check: | |
| name: Style check | |
| if: "!contains(github.event.head_commit.message, 'Bump version')" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: actions/checkout | |
| uses: actions/checkout@v3 | |
| - name: Set up Python 3.10 | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: "3.10" | |
| - name: Setup Rye | |
| id: setup-rye | |
| uses: eifinger/setup-rye@v4 | |
| with: | |
| enable-cache: true | |
| cache-prefix: ubuntu-20.04-rye-check-${{ hashFiles('pyproject.toml') }} | |
| - name: Run style check and linter | |
| run: | | |
| set -x | |
| rye fmt --check | |
| rye lint | |
| pytest: | |
| name: Run Pytest | |
| runs-on: ubuntu-latest | |
| if: "!contains(github.event.head_commit.message, 'Bump version')" | |
| strategy: | |
| matrix: | |
| python-version: ['3.10'] | |
| steps: | |
| - name: actions/checkout | |
| uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Setup Rye | |
| id: setup-rye | |
| uses: eifinger/setup-rye@v4 | |
| with: | |
| enable-cache: true | |
| cache-prefix: ubuntu-latest-rye-test-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }} | |
| - name: actions/cache | |
| uses: actions/cache@v3 | |
| with: | |
| path: ${{ env.LOCAL_CACHE }} | |
| key: ubuntu-latest-system-test-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }} | |
| restore-keys: ubuntu-latest-system-test | |
| - name: Install test and package dependencies | |
| run: | | |
| set -x | |
| sudo apt-get install -y xvfb -y | |
| sudo MUJOCO_PATH=/home/runner/.mujoco/ make install-envs | |
| rye pin --relaxed cpython@${{ matrix.python-version }} | |
| rye sync --all-features | |
| ROM_PASSWORD=${{ secrets.ROM_PASSWORD }} make import-roms | |
| - name: Test with pytest | |
| run: | | |
| set -x | |
| xvfb-run -s "-screen 0 1400x900x24" rye run codecov | |
| - name: Upload coverage report | |
| if: ${{ matrix.python-version=='3.10' }} | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| fail_ci_if_error: false # optional (default = false) | |
| flags: unittests # optional | |
| name: codecov-umbrella # optional | |
| token: ${{ secrets.CODECOV_TOKEN }} # required | |
| verbose: true # optional (default = false) | |
| # test-docker: | |
| # name: Test Docker container | |
| # runs-on: ubuntu-20.04 | |
| # if: "!contains(github.event.head_commit.message, 'Bump version')" | |
| # steps: | |
| # - uses: actions/checkout@v2 | |
| # - name: Build container | |
| # run: | | |
| # set -x | |
| # ROM_PASSWORD=${{ secrets.ROM_PASSWORD }} make docker-build | |
| # - name: Run tests | |
| # run: | | |
| # set -x | |
| # make docker-test | |
| build-test-package: | |
| name: Build and test the package | |
| needs: style-check | |
| runs-on: ubuntu-latest | |
| if: "!contains(github.event.head_commit.message, 'Bump version')" | |
| steps: | |
| - name: actions/checkout | |
| uses: actions/checkout@v3 | |
| - name: Set up Python 3.10 | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: '3.10' | |
| - name: Setup Rye | |
| id: setup-rye | |
| uses: eifinger/setup-rye@v4 | |
| with: | |
| enable-cache: true | |
| cache-prefix: ubuntu-latest-rye-build-3.10-${{ hashFiles('pyproject.toml') }} | |
| - name: actions/cache | |
| uses: actions/cache@v3 | |
| with: | |
| path: ${{ env.LOCAL_CACHE }} | |
| key: ubuntu-latest-system-build-3.10-${{ hashFiles('pyproject.toml') }} | |
| restore-keys: ubuntu-latest-system-test | |
| - name: Install build dependencies | |
| run: | | |
| set -x | |
| pip install uv | |
| rye install bump2version | |
| rye install twine | |
| - name: Create unique version for test.pypi | |
| run: | | |
| set -x | |
| current_version=$(grep __version__ $VERSION_FILE | cut -d\" -f2) | |
| ts=$(date +%s) | |
| new_version="$current_version$ts" | |
| bumpversion --current-version $current_version --new-version $new_version patch $VERSION_FILE | |
| - name: Build package | |
| run: | | |
| set -x | |
| rye build --clean | |
| twine check dist/* | |
| # - name: Publish package to TestPyPI | |
| # env: | |
| # TEST_PYPI_PASS: ${{ secrets.TEST_PYPI_PASS }} | |
| # if: "'$TEST_PYPI_PASS' != ''" | |
| # uses: pypa/gh-action-pypi-publish@release/v1 | |
| # with: | |
| # password: ${{ secrets.TEST_PYPI_PASS }} | |
| # repository-url: https://test.pypi.org/legacy/ | |
| # skip-existing: true | |
| - name: Install dependencies | |
| env: | |
| UV_SYSTEM_PYTHON: 1 | |
| run: | | |
| set -x | |
| sudo apt-get install -y xvfb | |
| sudo MUJOCO_PATH=/home/runner/.mujoco/ make install-envs | |
| rye lock --all-features | |
| uv pip install -r requirements.lock | |
| uv pip install dist/*.whl | |
| # ROM_PASSWORD=${{ secrets.ROM_PASSWORD }} python -m plangym.scripts.import_retro_roms | |
| # - name: Test package | |
| # env: | |
| # UV_SYSTEM_PYTHON: 1 | |
| # run: | | |
| # set -x | |
| # rm -rf $PROJECT_DIR | |
| # find . -name "*.pyc" -delete | |
| # make test | |
| bump-version: | |
| name: Bump package version | |
| env: | |
| BOT_AUTH_TOKEN: ${{ secrets.BOT_AUTH_TOKEN }} | |
| if: "!contains(github.event.head_commit.message, 'Bump version') && github.ref == 'refs/heads/master' && '$BOT_AUTH_TOKEN' != ''" | |
| runs-on: ubuntu-latest | |
| needs: | |
| - pytest | |
| - build-test-package | |
| # - test-docker | |
| steps: | |
| - name: actions/checkout | |
| uses: actions/checkout@v3 | |
| with: | |
| persist-credentials: false | |
| fetch-depth: 100 | |
| - name: current_version | |
| run: | | |
| set -x | |
| echo "current_version=$(grep __version__ $VERSION_FILE | cut -d\" -f2)" >> $GITHUB_ENV | |
| echo "version_file=$VERSION_FILE" >> $GITHUB_ENV | |
| echo 'bot_name="${BOT_NAME}"' >> $GITHUB_ENV | |
| echo 'bot_email="${BOT_EMAIL}"' >> $GITHUB_ENV | |
| - name: FragileTech/bump-version | |
| uses: FragileTech/bump-version@main | |
| with: | |
| current_version: "${{ env.current_version }}" | |
| files: "${{ env.version_file }}" | |
| commit_name: "${{ env.bot_name }}" | |
| commit_email: "${{ env.bot_email }}" | |
| login: "${{ env.bot_name }}" | |
| token: "${{ secrets.BOT_AUTH_TOKEN }}" | |
| # release-package: | |
| # name: Release PyPI package | |
| # env: | |
| # PYPI_PASS: ${{ secrets.PYPI_PASS }} | |
| # if: "contains(github.event.head_commit.message, 'Bump version') && github.ref == 'refs/heads/master' && '$PYPI_PASS' != ''" | |
| # runs-on: ubuntu-20.04 | |
| # steps: | |
| # - name: actions/checkout | |
| # uses: actions/checkout@v3 | |
| # - name: Set up Python 3.8 | |
| # uses: actions/setup-python@v3 | |
| # with: | |
| # python-version: 3.8 | |
| # - name: Install dependencies | |
| # run: | | |
| # set -x | |
| # python -m pip install -U pip | |
| # python -m pip install -U setuptools twine wheel | |
| # | |
| # - name: Build package | |
| # run: | | |
| # set -x | |
| # python setup.py --version | |
| # python setup.py bdist_wheel sdist --format=gztar | |
| # twine check dist/* | |
| # | |
| # - name: Publish package to PyPI | |
| # uses: pypa/gh-action-pypi-publish@master | |
| # with: | |
| # user: __token__ | |
| # password: ${{ secrets.PYPI_PASS }} |