add : documentation on test #3
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
| ## Publish package on release branch if it's tagged with 'v*' | |
| # | |
| #name: build & release | |
| # | |
| ## Controls when the action will run. | |
| #on: | |
| # # Triggers the workflow on push or pull request events but only for the master branch | |
| # push: | |
| # branch: [main, master] | |
| # tags: | |
| # - 'v*' | |
| # | |
| # # Allows you to run this workflow manually from the Actions tab | |
| # workflow_dispatch: | |
| # | |
| ## A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| #jobs: | |
| # release: | |
| # runs-on: ubuntu-latest | |
| # | |
| # strategy: | |
| # matrix: | |
| # python-versions: ['3.10'] | |
| # | |
| # # map step outputs to job outputs so they can be share among jobs | |
| # outputs: | |
| # package_version: ${{ steps.variables_step.outputs.package_version }} | |
| # package_name: ${{ steps.variables_step.outputs.package_name }} | |
| # repo_name: ${{ steps.variables_step.outputs.repo_name }} | |
| # repo_owner: ${{ steps.variables_step.outputs.repo_owner }} | |
| # | |
| # # Steps represent a sequence of tasks that will be executed as part of the job | |
| # steps: | |
| # # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| # - uses: actions/checkout@v2 | |
| # | |
| # - name: build change log | |
| # id: build_changelog | |
| # uses: mikepenz/release-changelog-builder-action@v3.2.0 | |
| # env: | |
| # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| # | |
| # - uses: actions/setup-python@v2 | |
| # with: | |
| # python-version: ${{ matrix.python-versions }} | |
| # | |
| # - name: Install dependencies | |
| # run: | | |
| # python -m pip install --upgrade pip | |
| # pip install poetry | |
| # | |
| # # declare package_version, repo_owner, repo_name, package_name so you may use it in web hooks. | |
| # - name: Declare variables for convenient use | |
| # id: variables_step | |
| # run: | | |
| # echo "::set-output name=repo_owner::${GITHUB_REPOSITORY%/*}" | |
| # echo "::set-output name=repo_name::${GITHUB_REPOSITORY#*/}" | |
| # echo "::set-output name=package_name::`poetry version | awk '{print $1}'`" | |
| # echo "::set-output name=package_version::`poetry version --short`" | |
| # shell: bash | |
| # | |
| # - name: publish documentation | |
| # run: | | |
| # poetry install -E doc | |
| # poetry run mkdocs build | |
| # git config --global user.name Docs deploy | |
| # git config --global user.email docs@dummy.bot.com | |
| # poetry run mike deploy -p -f --ignore `poetry version --short` | |
| # poetry run mike set-default -p `poetry version --short` | |
| # | |
| # - name: Build wheels and source tarball | |
| # run: | | |
| # poetry lock | |
| # poetry build | |
| # | |
| # - name: Create Release | |
| # id: create_release | |
| # uses: actions/create-release@v1 | |
| # env: | |
| # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| # with: | |
| # tag_name: ${{ github.ref_name }} | |
| # release_name: Release ${{ github.ref_name }} | |
| # body: ${{ steps.build_changelog.outputs.changelog }} | |
| # draft: false | |
| # prerelease: false | |
| # | |
| # - name: publish to PYPI | |
| # uses: pypa/gh-action-pypi-publish@release/v1 | |
| # with: | |
| # user: __token__ | |
| # password: ${{ secrets.PYPI_API_TOKEN }} | |
| # skip_existing: true |