From 11ce447dda87a5b5ac879348fa9d89c91901dee4 Mon Sep 17 00:00:00 2001 From: umarcor Date: Tue, 30 Nov 2021 23:58:41 +0100 Subject: [PATCH 1/7] ExamplePipeline: run Package unconditionally; Release needs Package --- ExamplePipeline.yml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/ExamplePipeline.yml b/ExamplePipeline.yml index 40ac7a9..5bffa42 100644 --- a/ExamplePipeline.yml +++ b/ExamplePipeline.yml @@ -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') From 7803d6efb95c0eebf94783f960ae2623b8e2e20f Mon Sep 17 00:00:00 2001 From: umarcor Date: Wed, 1 Dec 2021 00:11:11 +0100 Subject: [PATCH 2/7] add DEVELOPMENT.md --- DEVELOPMENT.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 DEVELOPMENT.md 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 +``` From 2032cff7871ef0ef1deac2036bb14caeb5b504f4 Mon Sep 17 00:00:00 2001 From: umarcor Date: Wed, 1 Dec 2021 00:36:33 +0100 Subject: [PATCH 3/7] ExamplePipeline/ArtifactCleanUp: needs UnitTesting --- ExamplePipeline.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/ExamplePipeline.yml b/ExamplePipeline.yml index 5bffa42..fed38f0 100644 --- a/ExamplePipeline.yml +++ b/ExamplePipeline.yml @@ -117,6 +117,7 @@ jobs: uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@main needs: - Params + - UnitTesting - Coverage - StaticTypeCheck - BuildTheDocs From df86bea2f9a225827854a173118e9d741807cbb3 Mon Sep 17 00:00:00 2001 From: umarcor Date: Thu, 2 Dec 2021 02:48:48 +0100 Subject: [PATCH 4/7] UnitTesting: update description of input 'jobs' --- .github/workflows/UnitTesting.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/UnitTesting.yml b/.github/workflows/UnitTesting.yml index 47c53b8..fea903b 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: From 9c31f34c4eca15ba2f3f93946062555cba4fb396 Mon Sep 17 00:00:00 2001 From: umarcor Date: Thu, 2 Dec 2021 02:49:29 +0100 Subject: [PATCH 5/7] ExamplePipeline: change name to just 'Pipeline' --- ExamplePipeline.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ExamplePipeline.yml b/ExamplePipeline.yml index fed38f0..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: From b0288cbe4b12523ae751e0b8fedb562f86a2ce66 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Sat, 4 Dec 2021 18:55:02 +0100 Subject: [PATCH 6/7] Added a PullRequest template. --- .github/pull_request_template.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/pull_request_template.md 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 From 00105dd491697e5152cc6f7da454f3c31e4e9c3d Mon Sep 17 00:00:00 2001 From: umarcor Date: Tue, 7 Dec 2021 02:48:09 +0100 Subject: [PATCH 7/7] UnitTesting: fix artifact upload condition --- .github/workflows/UnitTesting.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/UnitTesting.yml b/.github/workflows/UnitTesting.yml index fea903b..7dbca63 100644 --- a/.github/workflows/UnitTesting.yml +++ b/.github/workflows/UnitTesting.yml @@ -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 }}