docs: add basic and advanced documentation and refactor main readme #117
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: CI-CD | |
| on: [push] # yamllint disable-line rule:truthy | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| # ---------------------------------------------- | |
| # check-out repo and set-up python | |
| # ---------------------------------------------- | |
| - name: Check out repository | |
| uses: actions/checkout@v3 | |
| - name: Set up python | |
| id: setup-python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.9' | |
| # ---------------------------------------------- | |
| # ----- install & configure poetry ----- | |
| # ---------------------------------------------- | |
| - name: Install Poetry | |
| uses: snok/install-poetry@v1 | |
| with: | |
| virtualenvs-create: true | |
| virtualenvs-in-project: true | |
| installer-parallel: true | |
| # ---------------------------------------------- | |
| # install dependencies if cache does not exist | |
| # ---------------------------------------------- | |
| - name: Install dependencies | |
| if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' | |
| run: poetry install --no-interaction --no-root | |
| # ---------------------------------------------- | |
| # install your root project, if required | |
| # ---------------------------------------------- | |
| - name: Install project | |
| run: poetry install --no-interaction | |
| #---------------------------------------------- | |
| # run linting and tests | |
| #---------------------------------------------- | |
| - name: Run linting and tests | |
| run: poetry run pre-commit run --all-files --show-diff-on-failure | |
| #---------------------------------------------- | |
| # build package | |
| #---------------------------------------------- | |
| - name: Set build version and build package | |
| run: | | |
| poetry version 0.0.1.alpha${{ github.run_number}} | |
| poetry build | |
| # ---------------------------------------------- | |
| # upload dist | |
| # ---------------------------------------------- | |
| - name: Upload dist | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: dist | |
| path: dist | |
| publish: | |
| needs: build | |
| if: github.ref == 'refs/heads/main' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| id-token: write | |
| environment: | |
| name: pypi | |
| url: https://pypi.org/p/data-factory-testing-framework | |
| steps: | |
| - name: Download dist | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: dist | |
| path: dist | |
| - name: Publish package distributions to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| packages-dir: ./dist |