chore(no-ticket): Clean up ReadMe #23
Conversation
BartoszBlizniak
commented
Dec 19, 2025
BartoszBlizniak
commented
- Cleanup inputs
- Add repo badges
There was a problem hiding this comment.
Pull request overview
This PR cleans up the README.md file by restructuring the inputs documentation into clear tables and adding repository status badges. The changes improve readability and maintainability while removing decorative emoji characters from documentation sections.
- Adds status badges for test status, GitHub Marketplace, Node.js version, license, and releases
- Restructures inputs documentation from bullet points to organized tables with clear columns (Input, Description, Required, Default)
- Removes emoji characters from documentation text throughout the file
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Support | ||
|
|
||
| If you have any questions or need further assistance, please open an issue on GitHub. We're here to help! 💬 Alternatively, you can contact us at [support.cloudsmith.com](https://support.cloudsmith.com/). | ||
| If you have any questions or need further assistance, please open an issue on GitHub. We're here to help! Alternatively, you can contact us at [support.cloudsmith.com](https://support.cloudsmith.com/). |
There was a problem hiding this comment.
Emojis were removed from most of the document but still remain on this line. For consistency with the rest of the cleanup, this scroll emoji should also be removed.
| | `oidc-auth-only` | Only perform OIDC authentication without installing the CLI | No | `false` | | ||
| | `oidc-auth-retry` | Number of retry attempts for OIDC authentication (0-10), 5 seconds delay between retries | No | `3` | | ||
| | `oidc-audience` | Audience to request when retrieving the GitHub OIDC token. Use `https://github.com/<org-name>` for standard GitHub audience | No | `api://AzureADTokenExchange` | | ||
| | `pip-install` | Install the Cloudsmith CLI via pip | No | - | |
There was a problem hiding this comment.
The default value for pip-install should be false (as specified in action.yml line 39) rather than -. This provides more clarity about the actual default behavior.
| | `api-host` | API Host for Cloudsmith | No | - | | ||
| | `api-proxy` | API Proxy for Cloudsmith | No | - | | ||
| | `api-ssl-verify` | Verify SSL certificates for Cloudsmith API | No | - | | ||
| | `api-user-agent` | User Agent for Cloudsmith API | No | - | |
There was a problem hiding this comment.
Trailing whitespace detected after the pipe character at the end of this line. This should be removed for consistency with the other table rows.
| | `api-user-agent` | User Agent for Cloudsmith API | No | - | | |
| | `api-user-agent` | User Agent for Cloudsmith API | No | - | |
| | `oidc-namespace` | Cloudsmith organisation/namespace for OIDC | No | - | | ||
| | `oidc-service-slug` | Cloudsmith service account slug for OIDC | No | - | | ||
| | `oidc-auth-only` | Only perform OIDC authentication without installing the CLI | No | `false` | | ||
| | `oidc-auth-retry` | Number of retry attempts for OIDC authentication (0-10), 5 seconds delay between retries | No | `3` | |
There was a problem hiding this comment.
The README documentation for oidc-token-validate input is missing. This input is defined in action.yml (line 29-32) with a description "Validate the OIDC token after authentication" and a default value of 'true', but it's not documented in the README inputs table.
| | `oidc-auth-retry` | Number of retry attempts for OIDC authentication (0-10), 5 seconds delay between retries | No | `3` | | |
| | `oidc-auth-retry` | Number of retry attempts for OIDC authentication (0-10), 5 seconds delay between retries | No | `3` | | |
| | `oidc-token-validate` | Validate the OIDC token after authentication | No | `true` | |
|
|
||
| | Input | Description | Required | Default | | ||
| |------------------------|-------------|----------|---------| | ||
| | `cli-version` | Specific version of the Cloudsmith CLI to install | No | Latest | |
There was a problem hiding this comment.
The description for cli-version input is inconsistent between the README and action.yml. The action.yml states "A specific version of the Cloudsmith CLI is installed/used" while the README states "Specific version of the Cloudsmith CLI to install". The wording should be synchronized for clarity.
| | `cli-version` | Specific version of the Cloudsmith CLI to install | No | Latest | | |
| | `cli-version` | A specific version of the Cloudsmith CLI is installed/used | No | Latest | |
| | `oidc-auth-retry` | Number of retry attempts for OIDC authentication (0-10), 5 seconds delay between retries | No | `3` | | ||
| | `oidc-audience` | Audience to request when retrieving the GitHub OIDC token. Use `https://github.com/<org-name>` for standard GitHub audience | No | `api://AzureADTokenExchange` | | ||
| | `pip-install` | Install the Cloudsmith CLI via pip | No | - | | ||
| | `executable-path` | Path to the Cloudsmith CLI executable | No | `GITHUB_WORKSPACE/bin/` | |
There was a problem hiding this comment.
The default value for executable-path is incorrect. According to the source code (src/download-cli.js line 10), the actual default is GITHUB_WORKSPACE/bin/cloudsmith, not GITHUB_WORKSPACE/bin/. The table should show the complete path including the cloudsmith filename.
| | `executable-path` | Path to the Cloudsmith CLI executable | No | `GITHUB_WORKSPACE/bin/` | | |
| | `executable-path` | Path to the Cloudsmith CLI executable | No | `GITHUB_WORKSPACE/bin/cloudsmith` | |
| |------------------------|-------------|----------|---------| | ||
| | `cli-version` | Specific version of the Cloudsmith CLI to install | No | Latest | | ||
| | `api-key` | API Key for Cloudsmith authentication | No | - | | ||
| | `oidc-namespace` | Cloudsmith organisation/namespace for OIDC | No | - | |
There was a problem hiding this comment.
The word "organisation" uses British spelling. According to the coding guidelines, Americanized spelling should be used, so this should be "organization".
| | `oidc-namespace` | Cloudsmith organisation/namespace for OIDC | No | - | | |
| | `oidc-namespace` | Cloudsmith organization/namespace for OIDC | No | - | |
