docs: improve README with icon, full inputs, and About Pipery section#4
docs: improve README with icon, full inputs, and About Pipery section#4hbahadorzadeh merged 1 commit intomainfrom
Conversation
… README Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Code Review
This pull request significantly updates the README.md to provide a more comprehensive overview of the Pipery Python CI action, including a detailed pipeline steps table, an expanded list of inputs, and a new section about the Pipery platform. Feedback suggests adding the missing target_branch input to the documentation and restoring the Outputs section to include the version output.
| | `registry` | `pypi` | Registry target for release. | | ||
| | `version_bump` | `patch` | Version bump type: `patch`, `minor`, or `major`. | | ||
| | `pypi_token` | `` | PyPI API token for publishing. | | ||
| | `github_token` | `` | GitHub token for reintegration. | |
There was a problem hiding this comment.
The target_branch input is missing from the inputs table. Since this section is intended to be a comprehensive list of all available inputs, it should include this configuration option, especially as it is a key parameter for the reintegration step.
| | `github_token` | `` | GitHub token for reintegration. | | |
| | `github_token` | `` | GitHub token for reintegration. | | |
| | `target_branch` | `main` | Target branch for reintegration. | |
| | `skip_packaging` | `false` | Skip the packaging step. | | ||
| | `skip_release` | `false` | Skip the release step. | | ||
| | `skip_reintegration` | `false` | Skip the reintegration step. | | ||
|
|
There was a problem hiding this comment.
The action defines a version output in action.yml, but the documentation for outputs was removed in this update. It is recommended to include an "Outputs" section to inform users about the data available for use in subsequent steps of their workflow.
| ## Outputs | |
| | Name | Description | | |
| |---|---| | |
| | `version` | The new version string after the versioning step. | | |
Updates the README with: