actions/login-action
2
0
Fork 0
mirror of https://github.com/docker/login-action.git synced 2025-02-22 10:20:25 +00:00
Code Issues Projects Releases Packages Wiki Activity

kebab-case for action inputs, fix README, fix comments in retry tests

Browse source 
Signed-off-by: Fedor Dikarev <fedor.dikarev@gmail.com>
This commit is contained in:
Fedor Dikarev 2025-01-23 16:51:59 +01:00
parent fdf655e1ab
commit c4d11d0a1e
4 changed files with 17 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -500,16 +500,16 @@ jobs:
The following inputs can be used as `step.with` keys: The following inputs can be used as `step.with` keys:
| Name | Type | Default | Description | | Name | Type | Default | Description |
|------------|--------|---------|-------------------------------------------------------------------------------| |-----------------------|--------|---------|-------------------------------------------------------------------------------|
| `registry` | String | | Server address of Docker registry. If not set then will default to Docker Hub | | `registry` | String | | Server address of Docker registry. If not set then will default to Docker Hub |
| `username` | String | | Username for authenticating to the Docker registry | | `username` | String | | Username for authenticating to the Docker registry |
| `password` | String | | Password or personal access token for authenticating the Docker registry | | `password` | String | | Password or personal access token for authenticating the Docker registry |
| `ecr` | String | `auto` | Specifies whether the given registry is ECR (`auto`, `true` or `false`) | | `ecr` | String | `auto` | Specifies whether the given registry is ECR (`auto`, `true` or `false`) |
| `logout` | Bool | `true` | Log out from the Docker registry at the end of a job | | `logout` | Bool | `true` | Log out from the Docker registry at the end of a job |
| `http_codes_to_retry` | String | `408,500,502,504` | Comma separated list of HTTP error codes we want to retry | | `http-codes-to-retry` | String | `408,500,502,504` | Comma separated list of HTTP error codes we want to retry |
| `max_attempts` | String | `1` | Overall maximum number of attempts we will make trying to login (1 means no retries) | | `max-attempts` | String | `1` | Overall maximum number of attempts we could make (`1` means no retries) |
| `retry_timeout` | String | `15` | Timeout between retries, in seconds | | `retry-timeout` | String | `15` | Timeout between retries, in seconds |
## Contributing ## Contributing

3
__tests__/retries_fail.test.ts
View file

@ -9,7 +9,8 @@ test('login retries function', async () => {
let stderr_strings: string[] = []; let stderr_strings: string[] = [];
let call_count: number = -1; let call_count: number = -1;
// const execSpy = jest.spyOn(Docker, 'getExecOutput').mockImplementation(async () => { // using spyOn() here isn't enough, as we alter the logic
// so use `jest.fn()` here for the `Docker.getExecOutput`
Docker.getExecOutput = jest.fn(async () => { Docker.getExecOutput = jest.fn(async () => {
call_count++; call_count++;
console.log(`Mock: ${call_count}, ${stderr_strings}`); console.log(`Mock: ${call_count}, ${stderr_strings}`);

2
__tests__/retries_success.test.ts
View file

@ -7,6 +7,8 @@ test('login retries success function', async () => {
let stderr_strings: string[] = []; let stderr_strings: string[] = [];
let call_count: number = -1; let call_count: number = -1;
// using spyOn() here isn't enough, as we alter the logic
// so use `jest.fn()` here for the `Docker.getExecOutput`
Docker.getExecOutput = jest.fn(async () => { Docker.getExecOutput = jest.fn(async () => {
call_count++; call_count++;
console.log(`Mock: ${call_count}, ${stderr_strings}`); console.log(`Mock: ${call_count}, ${stderr_strings}`);

6
action.yml
View file

@ -24,14 +24,14 @@ inputs:
description: 'Log out from the Docker registry at the end of a job' description: 'Log out from the Docker registry at the end of a job'
default: 'true' default: 'true'
required: false required: false
http_codes_to_retry: http-codes-to-retry:
description: 'Comma separated list of HTTP error codes we want to retry' description: 'Comma separated list of HTTP error codes we want to retry'
default: '408,500,502,504' default: '408,500,502,504'
max_attempts: max-attempts:
description: 'Overall maximum number of attempts we will make trying to login' description: 'Overall maximum number of attempts we will make trying to login'
default: '1' default: '1'
required: false required: false
retry_timeout: retry-timeout:
description: 'Timeout between retries, in seconds' description: 'Timeout between retries, in seconds'
default: '15' default: '15'
required: false required: false