From 03d73fa356749964297820b29c01517595f15c48 Mon Sep 17 00:00:00 2001 From: Tektronix Bot Date: Fri, 30 Aug 2024 19:03:36 +0000 Subject: [PATCH] 1.2.0 Automatically generated by python-semantic-release --- .github/workflows/_reusable-package-release.yml | 4 ++-- .github/workflows/_reusable-package-testpypi.yml | 2 +- .github/workflows/_reusable-publish-api-comparison.yml | 2 +- .github/workflows/_reusable-publish-test-results.yml | 2 +- ...sable-update-python-and-pre-commit-dependencies.yml | 2 +- CHANGELOG.md | 10 ++++++++++ actions/create_unique_testpypi_version/readme.md | 2 +- actions/fetch_pr_number/readme.md | 2 +- actions/find_unreleased_changelog_items/readme.md | 2 +- actions/update_development_dependencies/readme.md | 2 +- pyproject.toml | 2 +- workflows/codeql-analysis.md | 2 +- workflows/enforce-community-standards.md | 2 +- workflows/package-build.md | 2 +- workflows/package-release.md | 2 +- workflows/package-testpypi.md | 2 +- workflows/publish-api-comparison.md | 2 +- workflows/publish-test-results.md | 2 +- workflows/sbom-scan.md | 2 +- workflows/test-code.md | 2 +- workflows/test-docs.md | 2 +- workflows/update-python-and-pre-commit-dependencies.md | 2 +- 22 files changed, 32 insertions(+), 22 deletions(-) diff --git a/.github/workflows/_reusable-package-release.yml b/.github/workflows/_reusable-package-release.yml index 8c3abddf..731c0667 100644 --- a/.github/workflows/_reusable-package-release.yml +++ b/.github/workflows/_reusable-package-release.yml @@ -104,7 +104,7 @@ jobs: previous-changelog-filepath: ${{ inputs.previous-changelog-filepath }} previous-release-notes-filepath: ${{ inputs.previous-release-notes-filepath }} - if: ${{ !endsWith(github.repository, '/python-package-ci-cd') }} # Run the public action when this is run outside the python-package-ci-cd repository - uses: tektronix/python-package-ci-cd/actions/find_unreleased_changelog_items@v1.1.1 + uses: tektronix/python-package-ci-cd/actions/find_unreleased_changelog_items@v1.2.0 with: release-level: ${{ inputs.release-level }} previous-changelog-filepath: ${{ inputs.previous-changelog-filepath }} @@ -134,7 +134,7 @@ jobs: previous-changelog-filepath: ${{ inputs.previous-changelog-filepath }} previous-release-notes-filepath: ${{ inputs.previous-release-notes-filepath }} - if: ${{ !endsWith(github.repository, '/python-package-ci-cd') }} # Run the public action when this is run outside the python-package-ci-cd repository - uses: tektronix/python-package-ci-cd/actions/find_unreleased_changelog_items@v1.1.1 + uses: tektronix/python-package-ci-cd/actions/find_unreleased_changelog_items@v1.2.0 with: previous-changelog-filepath: ${{ inputs.previous-changelog-filepath }} previous-release-notes-filepath: ${{ inputs.previous-release-notes-filepath }} diff --git a/.github/workflows/_reusable-package-testpypi.yml b/.github/workflows/_reusable-package-testpypi.yml index fd131cc5..c679b365 100644 --- a/.github/workflows/_reusable-package-testpypi.yml +++ b/.github/workflows/_reusable-package-testpypi.yml @@ -31,7 +31,7 @@ jobs: - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 with: fetch-depth: 0 - - uses: tektronix/python-package-ci-cd/actions/create_unique_testpypi_version@v1.1.1 + - uses: tektronix/python-package-ci-cd/actions/create_unique_testpypi_version@v1.2.0 id: create-version with: package-name: ${{ inputs.package-name }} diff --git a/.github/workflows/_reusable-publish-api-comparison.yml b/.github/workflows/_reusable-publish-api-comparison.yml index d8b4e5b7..94d6ccb4 100644 --- a/.github/workflows/_reusable-publish-api-comparison.yml +++ b/.github/workflows/_reusable-publish-api-comparison.yml @@ -31,7 +31,7 @@ jobs: github-repository: ${{ github.repository }} - if: ${{ !endsWith(github.repository, '/python-package-ci-cd') }} # Run the public action when this is run outside the python-package-ci-cd repository id: fetch-pr-number - uses: tektronix/python-package-ci-cd/actions/fetch_pr_number@v1.1.1 + uses: tektronix/python-package-ci-cd/actions/fetch_pr_number@v1.2.0 with: sha: ${{ github.event.workflow_run.head_sha }} github-repository: ${{ github.repository }} diff --git a/.github/workflows/_reusable-publish-test-results.yml b/.github/workflows/_reusable-publish-test-results.yml index 7a95e173..6aff68ef 100644 --- a/.github/workflows/_reusable-publish-test-results.yml +++ b/.github/workflows/_reusable-publish-test-results.yml @@ -35,7 +35,7 @@ jobs: github-repository: ${{ github.repository }} - if: ${{ !endsWith(github.repository, '/python-package-ci-cd') }} # Run the public action when this is run outside the python-package-ci-cd repository id: fetch-pr-number - uses: tektronix/python-package-ci-cd/actions/fetch_pr_number@v1.1.1 + uses: tektronix/python-package-ci-cd/actions/fetch_pr_number@v1.2.0 with: sha: ${{ github.event.workflow_run.head_sha }} github-repository: ${{ github.repository }} diff --git a/.github/workflows/_reusable-update-python-and-pre-commit-dependencies.yml b/.github/workflows/_reusable-update-python-and-pre-commit-dependencies.yml index c843fc75..df7462fb 100644 --- a/.github/workflows/_reusable-update-python-and-pre-commit-dependencies.yml +++ b/.github/workflows/_reusable-update-python-and-pre-commit-dependencies.yml @@ -93,7 +93,7 @@ jobs: pre-commit-hook-skip-list: ${{ inputs.pre-commit-hook-skip-list }} export-dependency-groups: ${{ inputs.export-dependency-groups }} - if: ${{ !endsWith(github.repository, '/python-package-ci-cd') }} # Run the public action when this is run outside the python-package-ci-cd repository - uses: tektronix/python-package-ci-cd/actions/update_development_dependencies@v1.1.1 + uses: tektronix/python-package-ci-cd/actions/update_development_dependencies@v1.2.0 with: dependency-dict: ${{ inputs.dependency-dict }} update-pre-commit: ${{ inputs.update-pre-commit }} diff --git a/CHANGELOG.md b/CHANGELOG.md index 2de95f11..0bc9583d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,16 @@ Valid subsections within a version are: Things to be included in the next release go here. +--- + +## v1.2.0 (2024-08-30) + +### Merged Pull Requests + +- feat: Add an action that can be used to fetch a PR number ([#32](https://github.com/tektronix/python-package-ci-cd/pull/32)) +- gh-actions(deps): Bump github/codeql-action ([#30](https://github.com/tektronix/python-package-ci-cd/pull/30)) +- Build a documentation site with mkdocs to allow testing more reusable workflows ([#28](https://github.com/tektronix/python-package-ci-cd/pull/28)) + ### Added - Added an action that can be used to fetch a PR number based on the `head_sha`. diff --git a/actions/create_unique_testpypi_version/readme.md b/actions/create_unique_testpypi_version/readme.md index e892a899..ce5641e9 100644 --- a/actions/create_unique_testpypi_version/readme.md +++ b/actions/create_unique_testpypi_version/readme.md @@ -37,7 +37,7 @@ jobs: - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 with: fetch-depth: 0 - - uses: tektronix/python-package-ci-cd/actions/create_unique_testpypi_version@v1.1.1 + - uses: tektronix/python-package-ci-cd/actions/create_unique_testpypi_version@v1.2.0 id: create-version with: package-name: my-package # required diff --git a/actions/fetch_pr_number/readme.md b/actions/fetch_pr_number/readme.md index 13ade655..3490a9b5 100644 --- a/actions/fetch_pr_number/readme.md +++ b/actions/fetch_pr_number/readme.md @@ -28,7 +28,7 @@ jobs: publish-results: runs-on: ubuntu-latest steps: - - uses: tektronix/python-package-ci-cd/actions/fetch_pr_number@v1.1.1 + - uses: tektronix/python-package-ci-cd/actions/fetch_pr_number@v1.2.0 id: fetch-pr-number with: sha: ${{ github.event.workflow_run.head_sha }} # required diff --git a/actions/find_unreleased_changelog_items/readme.md b/actions/find_unreleased_changelog_items/readme.md index 21c85b26..23be9324 100644 --- a/actions/find_unreleased_changelog_items/readme.md +++ b/actions/find_unreleased_changelog_items/readme.md @@ -48,7 +48,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 - - uses: tektronix/python-package-ci-cd/actions/find_unreleased_changelog_items@v1.1.1 + - uses: tektronix/python-package-ci-cd/actions/find_unreleased_changelog_items@v1.2.0 with: release-level: ${{ inputs.release-level }} # optional previous-changelog-filepath: .previous_changelog_for_template.md # optional diff --git a/actions/update_development_dependencies/readme.md b/actions/update_development_dependencies/readme.md index c5faa9de..7efb8eb6 100644 --- a/actions/update_development_dependencies/readme.md +++ b/actions/update_development_dependencies/readme.md @@ -46,7 +46,7 @@ jobs: ref: ${{ github.head_ref }} token: ${{ secrets.checkout-token }} - - uses: tektronix/python-package-ci-cd/actions/update_development_dependencies@v1.1.1 + - uses: tektronix/python-package-ci-cd/actions/update_development_dependencies@v1.2.0 with: repo-root: . # optional, defaults to the current working directory install-dependencies: false # optional, this will almost never need to be set to true diff --git a/pyproject.toml b/pyproject.toml index 5329eda6..96e4140c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -27,7 +27,7 @@ wrap-summaries = 0 [tool.poetry] package-mode = false -version = "1.1.1" +version = "1.2.0" [tool.poetry.dependencies] python = "~3.12" # This needs to stay in sync with all CI workflows diff --git a/workflows/codeql-analysis.md b/workflows/codeql-analysis.md index 50ba66c0..7d69c011 100644 --- a/workflows/codeql-analysis.md +++ b/workflows/codeql-analysis.md @@ -43,7 +43,7 @@ on: branches: [main] jobs: analyze: - uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-codeql-analysis.yml@v1.1.1 + uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-codeql-analysis.yml@v1.2.0 with: languages-array: '["python", "javascript"]' codeql-queries: security-extended,security-and-quality diff --git a/workflows/enforce-community-standards.md b/workflows/enforce-community-standards.md index ce3eb323..eeb28196 100644 --- a/workflows/enforce-community-standards.md +++ b/workflows/enforce-community-standards.md @@ -43,7 +43,7 @@ on: branches: [main] jobs: enforce-community-standards: - uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-enforce-community-standards.yml@v1.1.1 + uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-enforce-community-standards.yml@v1.2.0 ``` [workflow-file]: ../.github/workflows/_reusable-enforce-community-standards.yml diff --git a/workflows/package-build.md b/workflows/package-build.md index 1ec2769f..7a0a39c2 100644 --- a/workflows/package-build.md +++ b/workflows/package-build.md @@ -63,7 +63,7 @@ concurrency: cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} jobs: package-build: - uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-package-build.yml@v1.1.1 + uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-package-build.yml@v1.2.0 with: package-name: my_package # required python-versions-array: '["3.9", "3.10", "3.11", "3.12"]' # required diff --git a/workflows/package-release.md b/workflows/package-release.md index 3e6ce582..a79d5196 100644 --- a/workflows/package-release.md +++ b/workflows/package-release.md @@ -135,7 +135,7 @@ concurrency: # This concurrency is not required, but can be added if extra cont group: pypi jobs: package-release: - uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-package-release.yml@v1.1.1 + uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-package-release.yml@v1.2.0 with: package-name: my-package # required repo-name: owner/my-package # required diff --git a/workflows/package-testpypi.md b/workflows/package-testpypi.md index 8fa26d65..3484f6e2 100644 --- a/workflows/package-testpypi.md +++ b/workflows/package-testpypi.md @@ -72,7 +72,7 @@ concurrency: # This concurrency is not required, but can be added if extra cont group: pypi jobs: package-testpypi: - uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-package-testpypi.yml@v1.1.1 + uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-package-testpypi.yml@v1.2.0 with: package-name: my-package # required repo-name: owner/my-package # required diff --git a/workflows/publish-api-comparison.md b/workflows/publish-api-comparison.md index c616fa58..b4b2fe44 100644 --- a/workflows/publish-api-comparison.md +++ b/workflows/publish-api-comparison.md @@ -45,7 +45,7 @@ on: types: [completed] jobs: publish-api-comparison: - uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-publish-api-comparison.yml@v1.1.1 + uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-publish-api-comparison.yml@v1.2.0 permissions: checks: write pull-requests: write diff --git a/workflows/publish-test-results.md b/workflows/publish-test-results.md index e58ae3fb..b7c1391c 100644 --- a/workflows/publish-test-results.md +++ b/workflows/publish-test-results.md @@ -55,7 +55,7 @@ on: types: [completed] jobs: publish-test-results: - uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-publish-test-results.yml@v1.1.1 + uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-publish-test-results.yml@v1.2.0 with: operating-systems-array: '["ubuntu", "windows", "macos"]' # required permissions: diff --git a/workflows/sbom-scan.md b/workflows/sbom-scan.md index 23f3a530..192e2d67 100644 --- a/workflows/sbom-scan.md +++ b/workflows/sbom-scan.md @@ -51,7 +51,7 @@ on: types: [published] jobs: sbom-scan: - uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-sbom-scan.yml@v1.1.1 + uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-sbom-scan.yml@v1.2.0 permissions: security-events: write contents: write diff --git a/workflows/test-code.md b/workflows/test-code.md index c9e7f436..823da436 100644 --- a/workflows/test-code.md +++ b/workflows/test-code.md @@ -134,7 +134,7 @@ concurrency: cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} jobs: test-code: - uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-test-code.yml@v1.1.1 + uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-test-code.yml@v1.2.0 with: repo-name: owner/repo # required operating-systems-array: '["ubuntu", "windows", "macos"]' # optional diff --git a/workflows/test-docs.md b/workflows/test-docs.md index 6757e9bc..e625d056 100644 --- a/workflows/test-docs.md +++ b/workflows/test-docs.md @@ -89,7 +89,7 @@ concurrency: cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} jobs: test-docs: - uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-test-docs.yml@v1.1.1 + uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-test-docs.yml@v1.2.0 with: node-version: 20 # required python-version: '3.11' # required diff --git a/workflows/update-python-and-pre-commit-dependencies.md b/workflows/update-python-and-pre-commit-dependencies.md index 4876fc3e..3aadd6e1 100644 --- a/workflows/update-python-and-pre-commit-dependencies.md +++ b/workflows/update-python-and-pre-commit-dependencies.md @@ -56,7 +56,7 @@ on: branches: [main] jobs: update-python-and-pre-commit-dependencies: - uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-update-python-and-pre-commit-dependencies.yml@v1.1.1 + uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-update-python-and-pre-commit-dependencies.yml@v1.2.0 with: commit-user-name: 'User Name' commit-user-email: 'user-email'