CI #1431
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
| --- | |
| # README FIRST | |
| # 1. replace "NAMESPACE" and "COLLECTION_NAME" with the correct name in the env section (e.g. with 'community' and 'mycollection') | |
| # 2. If you don't have unit tests remove that section | |
| # 3. If your collection depends on other collections ensure they are installed, see "Install collection dependencies" | |
| # If you need help please ask in #ansible-community on the Libera.chat IRC network | |
| # TODO: | |
| # * properly set up tests | |
| # * check out how collection dependencies can be managed | |
| # * release management (changelogs, release notes, artifacts) | |
| name: CI | |
| "on": | |
| # Run CI against all pushes (direct commits, also merged PRs), Pull Requests | |
| push: | |
| branches: | |
| - main | |
| - stable-* | |
| pull_request: | |
| # Run CI once per day (at 06:00 UTC) | |
| # This ensures that even if there haven't been commits that we are still testing against latest version of ansible-test for each ansible-base version | |
| schedule: | |
| - cron: "0 6 * * *" | |
| env: | |
| NAMESPACE: mgit_at | |
| COLLECTION_NAME: roles | |
| jobs: | |
| ### | |
| # Sanity tests (REQUIRED) | |
| # | |
| # https://docs.ansible.com/ansible/latest/dev_guide/testing_sanity.html | |
| sanity: | |
| name: Sanity (Ⓐ${{ matrix.ansible }}) | |
| strategy: | |
| matrix: | |
| ansible: | |
| # It's important that Sanity is tested against all stable-X.Y branches | |
| # Testing against `devel` may fail as new tests are added. | |
| - stable-2.14 | |
| - stable-2.15 | |
| - stable-2.16 | |
| - devel | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Run sanity tests inside a Docker container. | |
| # The docker container has all the pinned dependencies that are | |
| # required and all Python versions Ansible supports. | |
| - name: Perform sanity testing | |
| uses: ansible-community/ansible-test-gh-action@release/v1 | |
| with: | |
| ansible-core-version: ${{ matrix.ansible }} | |
| testing-type: sanity | |
| # OPTIONAL If your sanity tests require code | |
| # from other collections, install them like this | |
| # test-deps: >- | |
| # ansible.netcommon | |
| # ansible.utils | |
| ### | |
| # pre-commit tests (using the pre-commit tool) | |
| # | |
| pre-commit: | |
| runs-on: ubuntu-latest | |
| name: pre-commit (${{ matrix.hook }}) | |
| strategy: | |
| # As soon as the first unit test fails, cancel the others to free up the CI queue | |
| fail-fast: true | |
| matrix: | |
| hook: | |
| # see .pre-commit-config.yml for hook names | |
| - lint-skips | |
| - yamllint | |
| - shellcheck | |
| - ansible-lint | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| with: | |
| path: ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}} | |
| - name: Set up Python | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: "3.10" | |
| - name: Install pre-commit | |
| run: pip install pre-commit | |
| # Run the pre-commit hooks | |
| - name: Run pre-commit | |
| run: pre-commit run --verbose --color always --all-files --hook-stage manual ${{ matrix.hook }} | |
| working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}} | |
| # TODO: Proper caching of both pre-commit as well as ansible-lint content | |
| ### | |
| # Unit tests (OPTIONAL) | |
| # | |
| # https://docs.ansible.com/ansible/latest/dev_guide/testing_units.html | |
| # units: | |
| # runs-on: ubuntu-latest | |
| # name: Units (Ⓐ${{ matrix.ansible }}) | |
| # strategy: | |
| # # As soon as the first unit test fails, cancel the others to free up the CI queue | |
| # fail-fast: true | |
| # matrix: | |
| # ansible: | |
| # # - stable-2.9 # Only if your collection supports Ansible 2.9 | |
| # - stable-2.10 | |
| # - stable-2.11 | |
| # - stable-2.12 | |
| # - devel | |
| # steps: | |
| # - name: Check out code | |
| # uses: actions/checkout@v2 | |
| # with: | |
| # path: ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}} | |
| # - name: Set up Python | |
| # uses: actions/setup-python@v2 | |
| # with: | |
| # # it is just required to run that once as "ansible-test units" in the docker image | |
| # # will run on all python versions it supports. | |
| # python-version: '3.10' | |
| # - name: Install ansible-base (${{ matrix.ansible }}) | |
| # run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check | |
| # # OPTIONAL If your unit test requires Python libraries from other collections | |
| # # Install them like this | |
| # - name: Install collection dependencies | |
| # run: ansible-galaxy collection install ansible.netcommon ansible.utils -p . | |
| # # Run the unit tests | |
| # - name: Run unit test | |
| # run: ansible-test units -v --color --docker --coverage | |
| # working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}} | |
| # # ansible-test support producing code coverage date | |
| # - name: Generate coverage report | |
| # run: ansible-test coverage xml -v --requirements --group-by command --group-by version | |
| # working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}} | |
| # # See the reports at https://codecov.io/gh/GITHUBORG/REPONAME | |
| # - uses: codecov/codecov-action@v1 | |
| # with: | |
| # fail_ci_if_error: false | |
| ### | |
| # Integration tests (RECOMMENDED) | |
| # | |
| # https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html | |
| # If the application you are testing is available as a docker container and you want to test | |
| # multiple versions see the following for an example: | |
| # https://github.com/ansible-collections/community.zabbix/tree/master/.github/workflows | |
| # integration: | |
| # runs-on: ubuntu-latest | |
| # name: I (Ⓐ${{ matrix.ansible }}+py${{ matrix.python }}) | |
| # strategy: | |
| # fail-fast: false | |
| # matrix: | |
| # ansible: | |
| # # - stable-2.9 # Only if your collection supports Ansible 2.9 | |
| # - stable-2.10 | |
| # - stable-2.11 | |
| # - stable-2.12 | |
| # - devel | |
| # python: | |
| # - 2.6 | |
| # - 2.7 | |
| # - 3.5 | |
| # - 3.6 | |
| # - 3.7 | |
| # - 3.8 | |
| # - 3.9 | |
| # - 3.10 | |
| # exclude: | |
| # # Because ansible-test doesn't support python3.9 for Ansible 2.9 | |
| # - ansible: stable-2.9 | |
| # python: 3.9 | |
| # # Because ansible-test doesn't support python3.10 for Ansible 2.9 | |
| # - ansible: stable-2.9 | |
| # python: 3.10 | |
| # steps: | |
| # - name: Check out code | |
| # uses: actions/checkout@v2 | |
| # with: | |
| # path: ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}} | |
| # - name: Set up Python | |
| # uses: actions/setup-python@v2 | |
| # with: | |
| # # it is just required to run that once as "ansible-test integration" in the docker image | |
| # # will run on all python versions it supports. | |
| # python-version: '3.10' | |
| # - name: Install ansible-base (${{ matrix.ansible }}) | |
| # run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check | |
| # # OPTIONAL If your integration test requires Python libraries or modules from other collections | |
| # # Install them like this | |
| # - name: Install collection dependencies | |
| # run: ansible-galaxy collection install ansible.netcommon -p . | |
| # # Run the integration tests | |
| # - name: Run integration test | |
| # run: ansible-test integration -v --color --retry-on-error --continue-on-error --diff --python ${{ matrix.python }} --docker --coverage | |
| # working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}} | |
| # # ansible-test support producing code coverage date | |
| # - name: Generate coverage report | |
| # run: ansible-test coverage xml -v --requirements --group-by command --group-by version | |
| # working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}} | |
| # # See the reports at https://codecov.io/gh/GITHUBORG/REPONAME | |
| # - uses: codecov/codecov-action@v1 | |
| # with: | |
| # fail_ci_if_error: false |