Skip to content

Commit

Permalink
docs: Add numbered lists to main Readme to enable easier visibility i…
Browse files Browse the repository at this point in the history
…nto the total number of actions/workflows in the repo
  • Loading branch information
nfelt14 committed Aug 29, 2024
1 parent 00abf16 commit ac7fa15
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,64 +18,64 @@ Python Packaging CI/CD.

## Actions

- [`create_unique_testpypi_version`](actions/create_unique_testpypi_version/readme.md)
1. [`create_unique_testpypi_version`](actions/create_unique_testpypi_version/readme.md)
- This action creates a unique version number for the provided Python package to enable uploading
the package to [TestPyPI](https://test.pypi.org).
- [`find_unreleased_changelog_items`](./actions/find_unreleased_changelog_items/readme.md)
2. [`find_unreleased_changelog_items`](./actions/find_unreleased_changelog_items/readme.md)
- This action will parse the repository's `CHANGELOG.md` file to determine if
there are any unreleased items. It will fail if it cannot find any unreleased
items, as this means that the package is not ready for a new release.
- [`update_development_dependencies`](./actions/update_development_dependencies/readme.md)
3. [`update_development_dependencies`](./actions/update_development_dependencies/readme.md)
- This action enables updating Python development dependencies using the
[`Poetry`](https://python-poetry.org/) package manager in-sync with
[`pre-commit`](https://pre-commit.com/) hooks.

## Reusable Workflows

- [`check-api-for-breaking-changes.yml`](./workflows/check-api-for-breaking-changes.md)
1. [`check-api-for-breaking-changes.yml`](./workflows/check-api-for-breaking-changes.md)
- This workflow will use the [`griffe`](https://mkdocstrings.github.io/griffe/) Python package to check for
any major or breaking changes in a package's API.
- [`codeql-analysis.yml`](./workflows/codeql-analysis.md)
2. [`codeql-analysis.yml`](./workflows/codeql-analysis.md)
- This workflow will checkout the code and then run a CodeQL analysis against the
specified languages.
- [`enforce-community-standards.yml`](./workflows/enforce-community-standards.md)
3. [`enforce-community-standards.yml`](./workflows/enforce-community-standards.md)
- This workflow will ensure that all necessary files are in place in order to meet the
Open Source Community Standards for a repository.
- [`package-build.yml`](./workflows/package-build.md)
4. [`package-build.yml`](./workflows/package-build.md)
- This workflow will build the package using the
[`hynek/build-and-inspect-python-package`](https://github.com/hynek/build-and-inspect-python-package)
action, and then verify that the package can be installed on each combination of Python version
and operating system specified.
- [`package-release.yml`](./workflows/package-release.md)
5. [`package-release.yml`](./workflows/package-release.md)
- This workflow will create a new release of the package using the
[`python-semantic-release`](https://python-semantic-release.readthedocs.io/en/latest/) tool.
It will then build the package, upload the package to [TestPyPI](https://test.pypi.org) and [PyPI](https://pypi.org),
create a new GitHub Release for the project,
and then verify that the package can be installed from [TestPyPI](https://test.pypi.org) and [PyPI](https://pypi.org).
- [`package-testpypi.yml`](./workflows/package-testpypi.md)
6. [`package-testpypi.yml`](./workflows/package-testpypi.md)
- This workflow will build the package using the
[`hynek/build-and-inspect-python-package`](https://github.com/hynek/build-and-inspect-python-package)
action, upload the package to [TestPyPI](https://test.pypi.org), and then verify that the package
can be installed from [TestPyPI](https://test.pypi.org).
- [`publish-api-comparison.yml`](./workflows/publish-api-comparison.md)
7. [`publish-api-comparison.yml`](./workflows/publish-api-comparison.md)
- This workflow will use the output from the
[`check-api-for-breaking-changes.yml`](./workflows/check-api-for-breaking-changes.md) workflow to create a
comment on the Pull Request that introduces the changes with a detailed breakdown of the changes.
- [`publish-test-results.yml`](./workflows/publish-test-results.md)
8. [`publish-test-results.yml`](./workflows/publish-test-results.md)
- This workflow will publish the test results from the `artifact_<operating-system-name>_tests` artifacts
uploaded by the [`test-code.yml`](./workflows/test-code.md) workflow by creating a
comment on the Pull Request that triggered the test run.
- [`sbom-scan.yml`](./workflows/sbom-scan.md)
9. [`sbom-scan.yml`](./workflows/sbom-scan.md)
- This workflow will create a Software Bill of Materials (SBOM) for the repository using the
[`anchore/sbom-action`](https://github.com/anchore/sbom-action) Action and then scan the
SBOM using the [`anchore/scan-action`](https://github.com/anchore/scan-action) Action.
- [`test-code.yml`](./workflows/test-code.md)
10. [`test-code.yml`](./workflows/test-code.md)
- This workflow will run the tests for the code in the repository that are defined by its
[`tox`](https://tox.wiki/en/stable/) configuration.
- [`test-docs.yml`](./workflows/test-docs.md)
11. [`test-docs.yml`](./workflows/test-docs.md)
- This workflow will run the documentation tests for the code in the repository that are defined by its
[`tox`](https://tox.wiki/en/stable/) configuration.
- [`update-python-and-pre-commit-dependencies.yml`](./workflows/update-python-and-pre-commit-dependencies.md)
12. [`update-python-and-pre-commit-dependencies.yml`](./workflows/update-python-and-pre-commit-dependencies.md)
- This workflow updates Python development dependencies using the
[`Poetry`](https://python-poetry.org/) package manager in-sync with
[`pre-commit`](https://pre-commit.com/) hooks when triggered as a part of
Expand Down

0 comments on commit ac7fa15

Please sign in to comment.