You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This GitHub Action installs the Cloudsmith CLI and pre-authenticates it using OIDC or API Key. 🚀
4
10
5
11
> **⚠️ 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. 🐍
6
12
7
13
## Inputs
8
14
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/`). 🛠️
|`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/`|
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).
40
54
41
55
```yaml
42
56
uses: cloudsmith-io/cloudsmith-cli-action@v1
@@ -63,12 +77,12 @@ This will:
63
77
64
78
## Cloudsmith CLI Commands
65
79
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)
67
81
68
82
69
83
### Publish a package
70
84
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.
72
86
73
87
```yaml
74
88
name: Publish Python Package
@@ -108,5 +122,5 @@ This project is licensed under the MIT License - see the LICENSE file for detail
108
122
109
123
## Support
110
124
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/).
0 commit comments