Skip to content

Commit 15cb93f

Browse files
danivilla9benoitf
authored andcommitted
chore(e2e): add github token to action input
Signed-off-by: Daniel Villanueva <davillan@redhat.com>
1 parent 6b757b7 commit 15cb93f

2 files changed

Lines changed: 47 additions & 4 deletions

File tree

README.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,47 @@ On Linux, the action installs Podman v5.x and its key dependencies (like CRIU) f
1212

1313
### Inputs
1414

15-
This action accepts two inputs to customize its behavior:
15+
This action accepts three inputs to customize its behavior:
1616

17-
podman-version-input: This input is used only on Windows runners. You can set it to 'latest' (which is the default) to automatically install the most recent Podman release, or provide a specific version string (e.g., '5.6.2') to install that exact version.
17+
**podman-version-input**: This input is used only on Windows runners. You can set it to 'latest' (which is the default) to automatically install the most recent Podman release, or provide a specific version string (e.g., '5.6.2') to install that exact version.
1818

19-
ubuntu-version: This input is used only on Linux runners. It specifies the Ubuntu version codename (like '23.10' or '22.04') needed to construct the correct URL for the Kubic repository. The default value is '23.10'.
19+
**ubuntu-version**: This input is used only on Linux runners. It specifies the Ubuntu version codename (like '23.10' or '22.04') needed to construct the correct URL for the Kubic repository. The default value is '23.10'.
20+
21+
**github-token**: (Optional) A GitHub token used to make authenticated API requests when fetching the latest Podman version on Windows. Providing this token helps avoid GitHub API rate limiting, especially in workflows that run frequently. If not provided, the action will make unauthenticated requests which are subject to stricter rate limits. Example: `github-token: ${{ secrets.GITHUB_TOKEN }}`.
22+
23+
## Usage
24+
25+
### Basic Usage
26+
27+
```yaml
28+
- name: Install Podman
29+
uses: redhat-actions/podman-install@main
30+
```
31+
32+
### With GitHub Token (Recommended for Windows)
33+
34+
```yaml
35+
- name: Install Podman
36+
uses: redhat-actions/podman-install@main
37+
with:
38+
github-token: ${{ secrets.GITHUB_TOKEN }}
39+
```
40+
41+
### Install Specific Podman Version on Windows
42+
43+
```yaml
44+
- name: Install Podman 5.6.2
45+
uses: redhat-actions/podman-install@main
46+
with:
47+
podman-version-input: '5.6.2'
48+
github-token: ${{ secrets.GITHUB_TOKEN }}
49+
```
50+
51+
### Custom Ubuntu Version for Linux
52+
53+
```yaml
54+
- name: Install Podman on Ubuntu 22.04
55+
uses: redhat-actions/podman-install@main
56+
with:
57+
ubuntu-version: '22.04'
58+
```

action.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ inputs:
2828
description: "Podman version for Windows. Use 'latest' or a specific version (e.g. '5.6.2')."
2929
required: false
3030
default: "latest"
31+
github-token:
32+
description: "GitHub token to make authenticated API requests and avoid rate limiting."
33+
required: false
3134

3235
runs:
3336
using: "composite"
@@ -67,10 +70,11 @@ runs:
6770
- name: Fetch Podman Download URL for Windows
6871
if: runner.os == 'Windows'
6972
id: fetch-podman-url
70-
uses: redhat-actions/podman-install/.github/actions/fetch-latest-podman-version-windows@e4b1fa48c45110617d0ae3a995b81428f4234d96
73+
uses: redhat-actions/podman-install/.github/actions/fetch-latest-podman-version-windows@6b757b792b67ec663765a4f2ca36226e12b2f4cd
7174
with:
7275
version_input: ${{ inputs.podman-version-input || 'latest' }}
7376
file_type: 'setup.exe'
77+
github_token: ${{ inputs.github-token }}
7478

7579
- name: Install Podman on Windows
7680
if: runner.os == 'Windows'

0 commit comments

Comments
 (0)