docs: Fill the documentation with introduction, examples, installatio… #4
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
| # Release workflow for push commits to the master branch | |
| # This workflow uses python semantic releases, which relies on certain commit tags to | |
| # determine if a new release/version should be created. | |
| # Checkout https://github.com/python-semantic-release/python-semantic-release form more | |
| # info on how to use it. | |
| # Also checkout https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type to | |
| # which types of commit messages are accepted | |
| name: Release | |
| on: | |
| push: | |
| branches: | |
| - master | |
| jobs: | |
| release: | |
| name: Semantic Release | |
| runs-on: ubuntu-latest | |
| concurrency: push | |
| if: github.repository == 'swvanbuuren/simple-cdd-yaml' | |
| environment: | |
| name: pypi | |
| url: https://pypi.org/project/simple-cdd-yaml/ | |
| permissions: | |
| id-token: write | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| ref: ${{ github.ref_name }} | |
| - name: Python Semantic Release | |
| id: release | |
| uses: python-semantic-release/python-semantic-release@master | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Set up Python | |
| if: steps.release.outputs.released == 'true' | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' | |
| - name: Install dependencies | |
| if: steps.release.outputs.released == 'true' | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install build | |
| - name: Build package | |
| if: steps.release.outputs.released == 'true' | |
| run: python -m build | |
| - name: Publish package distributions to PyPI | |
| id: pypi-publish | |
| if: steps.release.outputs.released == 'true' | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| verbose: true | |
| - name: Publish package distributions to GitHub Releases | |
| id: github-release | |
| if: steps.release.outputs.released == 'true' | |
| uses: python-semantic-release/upload-to-gh-release@main | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| tag: ${{ steps.release.outputs.tag }} |