docs: add easy configuration feature to README #14
This file contains hidden or 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: Release | |
| on: | |
| push: | |
| branches: [main] | |
| jobs: | |
| test: | |
| name: Test Python ${{ matrix.python-version }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ['3.8', '3.9', '3.10', '3.11', '3.12'] | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Cache pip dependencies | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e ".[dev]" | |
| - name: Lint with flake8 | |
| run: | | |
| flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics | |
| flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics | |
| - name: Check code formatting with black | |
| run: | | |
| black --check --diff . | |
| - name: Type check with mypy | |
| run: | | |
| mypy src/lingodotdev | |
| - name: Test with pytest | |
| run: | | |
| pytest --cov=src/lingodotdev --cov-report=xml --cov-report=term-missing | |
| release: | |
| name: Release | |
| runs-on: ubuntu-latest | |
| needs: test | |
| concurrency: release | |
| permissions: | |
| id-token: write # IMPORTANT: this permission is mandatory for trusted publishing | |
| contents: write # IMPORTANT: this permission is mandatory for creating releases | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.11' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install python-semantic-release build | |
| - name: Check if release needed | |
| id: check_release | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| # Check if semantic-release would create a release | |
| VERSION_OUTPUT=$(semantic-release version --print 2>&1) | |
| if echo "$VERSION_OUTPUT" | grep -q "No release will be made"; then | |
| echo "release_needed=false" >> $GITHUB_OUTPUT | |
| echo "No release needed: $VERSION_OUTPUT" | |
| elif echo "$VERSION_OUTPUT" | grep -q "already exists"; then | |
| echo "release_needed=false" >> $GITHUB_OUTPUT | |
| echo "Version already exists: $VERSION_OUTPUT" | |
| else | |
| echo "release_needed=true" >> $GITHUB_OUTPUT | |
| echo "Release needed: $VERSION_OUTPUT" | |
| fi | |
| - name: Run semantic release (version) | |
| if: steps.check_release.outputs.release_needed == 'true' | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| semantic-release version | |
| - name: Build package | |
| if: steps.check_release.outputs.release_needed == 'true' | |
| run: | | |
| python -m build | |
| - name: Publish to PyPI | |
| if: steps.check_release.outputs.release_needed == 'true' | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| print-hash: true | |
| - name: Create GitHub release | |
| if: steps.check_release.outputs.release_needed == 'true' | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| semantic-release publish |