Skip to content

Latest commit

 

History

History
64 lines (50 loc) · 5.83 KB

README.md

File metadata and controls

64 lines (50 loc) · 5.83 KB

Workflow and Action Documentation

This index provides a quick overview of the available workflow and action documentation in this repository. Each workflow and action serves a distinct purpose and is reusable via workflow_call. Use the table below to navigate to the specific documentation.

Reusable Flows

Name Description
github-release Automates creating and tagging releases on GitHub.
docker-publish Automates building and publishing Docker images.
github-release Creates a GitHub release based on the specified version.
maven-publish Automates signing and deploying Maven artifacts to a repository.
python-publish Automates building, testing, and publishing Python packages.
release-drafter Drafts a new release based on merged pull requests.
tag-creator Creates a new tag in the repository.

Template Flows

Name Description
automatic-pr-labeler Automatically labels pull requests when they are opened or reopened.
auto-labeler Automatically labels pull requests based on conventional commits.
cla Manages Contributor License Agreements (CLA) for pull requests.
go-check-license Checks licenses for Go modules.
pr-collect-commit-messages Collects commit messages from a pull request and adds them to the description.
pr-conventional-commits Checks if pull request commits follow the Conventional Commits specification.
pr-lint-title Lints the pull request title to ensure it follows the Conventional Commits specification.
prettier Runs Prettier to format code.
prettierFix Fixes code formatting issues using Prettier.
profanity-filter Filters profanity in issues, comments, and pull requests.
profanityFilter Filters profanity in issues, comments, and pull requests.
super-linter Runs multiple linters to validate code.

System Flows

Name Description
broadcast-files Allows to propagate common workflows, common configs etc. across the organization or specific repo.

Actions

Action Name Description
archive-and-upload-assets Archives and uploads assets to a specified location.
cdxgen Generates SBOM file and CycloneDX vulnerability report.
chart-version Manages and updates chart versions.
commit-and-push Automates committing and pushing changes to a remote repository.
custom-event Triggers a custom repository_dispatch event in the repository.
metadata-action Automates the management of repository metadata, including meta info, dist-tag, github context, and semver information based on branch or tag references.
poetry-publisher Automates building, testing, and publishing Python packages using Poetry.
pom-updater Automatically updates the pom.xml file in Maven projects.
pr-add-messages Adds commit messages to the pull request description.
pr-assigner Automatically assigns reviewers to pull requests based on configuration or CODEOWNERS file.
tag-checker Verifies the presence of specific tags in the repository.
verify-json Verifies the structure and content of JSON files.

Usage

Refer to the respective documentation for detailed instructions on inputs, secrets, and example usage. For any questions or issues, feel free to contact the repository maintainers.