Skip to content

docs: improve README with icon, full inputs, and About Pipery section#4

Merged
hbahadorzadeh merged 1 commit intomainfrom
docs/readme-update
Apr 28, 2026
Merged

docs: improve README with icon, full inputs, and About Pipery section#4
hbahadorzadeh merged 1 commit intomainfrom
docs/readme-update

Conversation

@hbahadorzadeh
Copy link
Copy Markdown
Contributor

Updates the README with:

  • Action icon (Feather icon matching the action branding) in the title
  • Short description of what the action does
  • Full inputs table with all available inputs and defaults
  • About Pipery section with the Pipery zap icon explaining psh and the ecosystem
  • Links to the Pipery Dashboard, Marketplace, and source

… README

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@hbahadorzadeh hbahadorzadeh merged commit ac3c3cd into main Apr 28, 2026
@hbahadorzadeh hbahadorzadeh deleted the docs/readme-update branch April 28, 2026 17:38
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
| `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. |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
| `github_token` | `` | GitHub token for reintegration. |
| `github_token` | `` | GitHub token for reintegration. |
| `target_branch` | `main` | Target branch for reintegration. |

Comment thread README.md
| `skip_packaging` | `false` | Skip the packaging step. |
| `skip_release` | `false` | Skip the release step. |
| `skip_reintegration` | `false` | Skip the reintegration step. |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
## Outputs
| Name | Description |
|---|---|
| `version` | The new version string after the versioning step. |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant