Skip to content

Commit 8a98bd3

Browse files
chore(no-ticket): Clean up ReadMe (#23)
* Cleanup readme
1 parent 9005367 commit 8a98bd3

File tree

1 file changed

+33
-19
lines changed

1 file changed

+33
-19
lines changed

README.md

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,45 @@
11
# Cloudsmith CLI Install Action
22

3+
[![Test Status](https://github.com/cloudsmith-io/cloudsmith-cli-action/actions/workflows/test_install.yml/badge.svg)](https://github.com/cloudsmith-io/cloudsmith-cli-action/actions/workflows/test_install.yml)
4+
[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Cloudsmith%20CLI%20Install-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=github)](https://github.com/marketplace/actions/cloudsmith-cli-install-action)
5+
[![Node.js Version](https://img.shields.io/badge/node-20-brightgreen.svg)](https://nodejs.org/)
6+
[![License](https://img.shields.io/github/license/cloudsmith-io/cloudsmith-cli-action.svg)](LICENSE)
7+
[![Version](https://img.shields.io/github/v/release/cloudsmith-io/cloudsmith-cli-action.svg)](https://github.com/cloudsmith-io/cloudsmith-cli-action/releases)
8+
39
This GitHub Action installs the Cloudsmith CLI and pre-authenticates it using OIDC or API Key. 🚀
410

511
> **⚠️ Notice:** If you are running on self-hosted runners, Python version 3.9 or higher is required. Please ensure your runner meets this requirement to avoid any issues. We recommend using [setup-python](https://github.com/actions/setup-python) action for installing Python. 🐍
612
713
## Inputs
814

9-
- `cli-version` (action.yml): A specific version of the Cloudsmith CLI to install (optional). 📦
10-
- `api-key` (action.yml): API Key for Cloudsmith (optional). 🔑
11-
- `oidc-namespace` (action.yml): Cloudsmith organisation/namespace for OIDC (optional). 🌐
12-
- `oidc-service-slug` (action.yml): Cloudsmith service account slug for OIDC (optional). 🐌
13-
- `oidc-auth-only` (action.yml): Only perform OIDC authentication without installing the CLI (optional, default: false). 🔐
14-
- `oidc-auth-retry` (action.yml): Number of retry attempts for OIDC authentication (0-10), 5 seconds delay between retries (optional, default: 3). 🔄
15-
- `oidc-audience` (action.yml): Audience to request when retrieving the GitHub OIDC token. Defaults to `api://AzureADTokenExchange` for backward compatibility. Set to `https://github.com/<org-name>` (e.g. `https://github.com/cloudsmith-io`) to use the standard GitHub audience. 🎯
16-
- `pip-install` (action.yml): Install the Cloudsmith CLI via pip (optional). 🐍
17-
- `executable-path` (action.yml): Path to the Cloudsmith CLI executable (optional, default: `GITHUB_WORKSPACE/bin/`). 🛠️
15+
### Authentication & Installation
16+
17+
| Input | Description | Required | Default |
18+
|------------------------|-------------|----------|---------|
19+
| `cli-version` | Specific version of the Cloudsmith CLI to install | No | Latest |
20+
| `api-key` | API Key for Cloudsmith authentication | No | - |
21+
| `oidc-namespace` | Cloudsmith organisation/namespace for OIDC | No | - |
22+
| `oidc-service-slug` | Cloudsmith service account slug for OIDC | No | - |
23+
| `oidc-auth-only` | Only perform OIDC authentication without installing the CLI | No | `false` |
24+
| `oidc-auth-retry` | Number of retry attempts for OIDC authentication (0-10), 5 seconds delay between retries | No | `3` |
25+
| `oidc-audience` | Audience to request when retrieving the GitHub OIDC token. Use `https://github.com/<org-name>` for standard GitHub audience | No | `api://AzureADTokenExchange` |
26+
| `pip-install` | Install the Cloudsmith CLI via pip | No | - |
27+
| `executable-path` | Path to the Cloudsmith CLI executable | No | `GITHUB_WORKSPACE/bin/` |
28+
29+
### CLI Configuration
1830

19-
## CLI Configuration Inputs ([documentation](https://github.com/cloudsmith-io/cloudsmith-cli?tab=readme-ov-file#non-credentials-configini))
31+
See [CLI configuration documentation](https://github.com/cloudsmith-io/cloudsmith-cli?tab=readme-ov-file#non-credentials-configini) for more details.
2032

21-
- `api-host`: API Host for Cloudsmith (optional). 🌐
22-
- `api-proxy`: API Proxy for Cloudsmith (optional). 🔗
23-
- `api-ssl-verify`: Verify SSL certificates for Cloudsmith API (optional). 🔒
24-
- `api-user-agent`: User Agent for Cloudsmith API (optional). 🕵️‍♂️
33+
| Input | Description | Required | Default |
34+
|------------------------|-------------|----------|---------|
35+
| `api-host` | API Host for Cloudsmith | No | - |
36+
| `api-proxy` | API Proxy for Cloudsmith | No | - |
37+
| `api-ssl-verify` | Verify SSL certificates for Cloudsmith API | No | - |
38+
| `api-user-agent` | User Agent for Cloudsmith API | No | - |
2539

2640
## Example Usage with OIDC
2741

28-
Cloudsmith OIDC [documentation](https://docs.cloudsmith.com/authentication/openid-connect) 📚
42+
Cloudsmith OIDC [documentation](https://docs.cloudsmith.com/authentication/openid-connect)
2943

3044
```yaml
3145
uses: cloudsmith-io/cloudsmith-cli-action@v1
@@ -36,7 +50,7 @@ with:
3650
3751
## Example Usage with API Key
3852
39-
Personal API Key can be found [here](https://cloudsmith.io/user/settings/api/). For CI-CD deployments we recommend using [Service Accounts](https://docs.cloudsmith.com/accounts-and-teams/service-accounts). 🔒
53+
Personal API Key can be found [here](https://cloudsmith.io/user/settings/api/). For CI-CD deployments we recommend using [Service Accounts](https://docs.cloudsmith.com/accounts-and-teams/service-accounts).
4054
4155
```yaml
4256
uses: cloudsmith-io/cloudsmith-cli-action@v1
@@ -63,12 +77,12 @@ This will:
6377

6478
## Cloudsmith CLI Commands
6579

66-
Full CLI feature list can be found [here](https://github.com/cloudsmith-io/cloudsmith-cli?tab=readme-ov-file#features) 📖
80+
Full CLI feature list can be found [here](https://github.com/cloudsmith-io/cloudsmith-cli?tab=readme-ov-file#features)
6781

6882

6983
### Publish a package
7084

71-
For all supported package formats and upload commands please visit our [Supported Formats](https://docs.cloudsmith.com/formats) page. 📦
85+
For all supported package formats and upload commands please visit our [Supported Formats](https://docs.cloudsmith.com/formats) page.
7286

7387
```yaml
7488
name: Publish Python Package
@@ -108,5 +122,5 @@ This project is licensed under the MIT License - see the LICENSE file for detail
108122

109123
## Support
110124

111-
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/).
125+
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/).
112126

0 commit comments

Comments
 (0)