diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..7a345ae --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,8 @@ +# New Features +* tbd + +# Changes +* tbd + +# Bug Fixes +* tbd diff --git a/.github/workflows/UnitTesting.yml b/.github/workflows/UnitTesting.yml index 47c53b8..7dbca63 100644 --- a/.github/workflows/UnitTesting.yml +++ b/.github/workflows/UnitTesting.yml @@ -4,7 +4,7 @@ on: workflow_call: inputs: jobs: - description: 'Space separated list of Python versions to run tests with.' + description: 'JSON list with field , telling the versions to run tests with.' required: true type: string requirements: @@ -49,7 +49,7 @@ jobs: python -m pytest -rA tests/unit $PYTEST_ARGS --color=yes - name: 📤 Upload 'TestReport.xml' artifact - if: inputs.TestReport == 'true' + if: inputs.artifact != '' uses: actions/upload-artifact@v2 with: name: ${{ inputs.artifact }}-${{ matrix.python }} diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..067df7f --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,22 @@ +# Development + +## Tagging/versioning + +See context in [#5](https://github.com/pyTooling/Actions/issues/5). + +Tag new releases in the `main` branch using a semver compatible value, starting with `v`: + +```sh +git checkout main +git tag v0.0.0 +git push upstream v0.0.0 +``` + +Move the corresponding release branch (starting with `r`) forward by creating a merge commit, and using the merged tag +as the commit message: + +```sh +git checkout r0 +git merge --no-ff -m 'v0.0.0' v0.0.0 +git push upstream r0 +``` diff --git a/ExamplePipeline.yml b/ExamplePipeline.yml index 40ac7a9..383deac 100644 --- a/ExamplePipeline.yml +++ b/ExamplePipeline.yml @@ -1,4 +1,4 @@ -name: Unit Testing, Coverage Collection, Package, Release, Documentation and Publish +name: Pipeline on: workflow_dispatch: @@ -49,17 +49,8 @@ jobs: requirements: '-r tests/requirements.txt' report: 'htmlmypy' - Release: - uses: pyTooling/Actions/.github/workflows/Release.yml@main - if: startsWith(github.ref, 'refs/tags') - needs: - - UnitTesting - - Coverage - - StaticTypeCheck - Package: uses: pyTooling/Actions/.github/workflows/Package.yml@main - if: startsWith(github.ref, 'refs/tags') needs: - Params - Coverage @@ -69,6 +60,15 @@ jobs: python_version: ${{ fromJson(needs.Params.outputs.params).python_version }} requirements: 'wheel' + Release: + uses: pyTooling/Actions/.github/workflows/Release.yml@main + if: startsWith(github.ref, 'refs/tags') + needs: + - UnitTesting + - Coverage + - StaticTypeCheck + - Package + PublishOnPyPI: uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@main if: startsWith(github.ref, 'refs/tags') @@ -117,6 +117,7 @@ jobs: uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@main needs: - Params + - UnitTesting - Coverage - StaticTypeCheck - BuildTheDocs