This repository has been archived by the owner on May 29, 2024. It is now read-only.
docs: polish documentation #258
Workflow file for this run
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: Lint | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| workflow_dispatch: | |
| jobs: | |
| lint-commits: | |
| if: github.actor != 'dependabot[bot]' | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Check commits | |
| uses: wagoid/commitlint-github-action@v5 | |
| lint-poetry: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.9 | |
| - name: Install Python Poetry | |
| uses: abatilo/[email protected] | |
| with: | |
| poetry-version: 1.3.1 | |
| - name: Check poetry config is valid | |
| run: | | |
| poetry check | |
| lint-python-code: | |
| needs: lint-poetry | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.9 | |
| - name: Install Python Poetry | |
| uses: abatilo/[email protected] | |
| with: | |
| poetry-version: 1.3.1 | |
| - name: Install project dependencies | |
| run: | | |
| poetry install | |
| - name: Lint code (flake8) | |
| run: | | |
| poetry run flake8 --count --show-source --statistics | |
| - name: Lint python code (mypy) | |
| uses: jpetrucciani/[email protected] | |
| with: | |
| path: '.' | |
| lint-dockerfile: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v3 | |
| - name: Lint dockerfile (hadolint) | |
| uses: hadolint/[email protected] | |
| lint-markdown: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v3 | |
| - name: Lint markdown files | |
| uses: avto-dev/[email protected] | |
| with: | |
| args: "**/*.md" | |
| lint-yaml: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v3 | |
| - name: Lint yaml files | |
| uses: ibiqlik/[email protected] | |
| lint-branch-name: | |
| runs-on: ubuntu-22.04 | |
| if: github.actor != 'dependabot[bot]' && github.event_name == 'pull_request' && (github.event.action == 'opened' || github.event.action == 'reopened') | |
| steps: | |
| - name: Check branch name conventions | |
| uses: AlbertHernandez/[email protected] | |
| with: | |
| branch_pattern: "feat|fix|build|ci|docs|style|refactor|perf|test|chore" | |
| comment_for_invalid_branch_name: | | |
| 🙋 Oops! This branch name does not follow the naming convention. | |
| <hr> | |
| Please, see the following branch naming convention: | |
| Branch naming convention | Purpose | |
| ------------------------ | ------- | |
| `feat/**` | A new feature | |
| `fix/**` | A bug fix | |
| `build/**` | Changes that affect the build system (npm, mavem, poetry) | |
| `ci/**` | Changes to the CI configuration | |
| `docs/**` | Documentation only changes | |
| `style/**` | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | |
| `refactor/**` | Code changes that neither fixe a bug nor adds a feature | |
| `perf/**` | Code changes that improve performance | |
| `test/**` | When adding tests or correcting existing tests | |
| `chore/**` | Other changes that don't modify source | |
| fail_if_invalid_branch_name: "true" | |
| ignore_branch_pattern: "main" | |
| - name: Close non-compliant branch | |
| if: ${{ failure() }} | |
| uses: codelytv/no-pull-requests@v1 | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.OKP4_TOKEN }} | |
| message: 🙅 Closing the PR because it does not respect naming conventions. Edit the branch name and submit a new PR. | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.OKP4_TOKEN }} |