|
1 | 1 | <!-- start title --> |
2 | 2 |
|
3 | | -# GitHub Action:Hello World |
| 3 | +# GitHub Action:Kind Test |
4 | 4 |
|
5 | 5 | <!-- end title --> |
6 | 6 | <!-- start description --> |
7 | 7 |
|
8 | | -Greet someone |
| 8 | +Creates a kind cluster, installs helm charts, runs an app via skaffold, and runs tests |
9 | 9 |
|
10 | 10 | <!-- end description --> |
11 | 11 | <!-- start contents --> |
12 | 12 | <!-- end contents --> |
13 | 13 | <!-- start usage --> |
14 | 14 |
|
15 | 15 | ```yaml |
16 | | -- uses: Unsupervisedcom/action-composite-action-template@undefined |
| 16 | +- uses: Unsupervisedcom/action-kind-test@undefined |
17 | 17 | with: |
18 | | - # Who to greet |
19 | | - # Default: World |
20 | | - who-to-greet: "" |
| 18 | + # Github token, if there are dependencies, this should be a PAT so that the other |
| 19 | + # repos can be cloned |
| 20 | + # Default: ${{ github.token }} |
| 21 | + token: "" |
| 22 | + |
| 23 | + # Git ref to use |
| 24 | + # Default: ${{ github.ref }} |
| 25 | + ref: "" |
| 26 | + |
| 27 | + # What test command to run |
| 28 | + # Default: go test |
| 29 | + test-command: "" |
| 30 | + |
| 31 | + # Directory to run tests from |
| 32 | + # Default: test |
| 33 | + test-working-directory: "" |
| 34 | + |
| 35 | + # Ports to wait for, used for dependent charts, if those charts need exposed local |
| 36 | + # ports as part of testing. Comma separated list such as `8000,8001` |
| 37 | + # Default: |
| 38 | + wait-for-ports: "" |
| 39 | + |
| 40 | + # Max time in milliseconds to wait for readiness on ports set in `wait-for-ports` |
| 41 | + # Default: 300000 |
| 42 | + max-wait: "" |
| 43 | + |
| 44 | + # Interval to check readiness on ports set in `wait-for-ports` |
| 45 | + # Default: 5000 |
| 46 | + check-interval: "" |
| 47 | + |
| 48 | + # Helm charts to install, a json formatted string, that is a list of objects |
| 49 | + # Default: [] |
| 50 | + helm-charts: "" |
| 51 | + |
| 52 | + # Gcloud service account credentials json. This is required if you are installing |
| 53 | + # helm charts |
| 54 | + credentials-json: "" |
| 55 | + |
| 56 | + # gcloud project id. This is required if you are installing helm charts |
| 57 | + project-id: "" |
| 58 | + |
| 59 | + # artifact registry region |
| 60 | + # Default: us-west1 |
| 61 | + region: "" |
| 62 | + |
| 63 | + # artifact registry repository |
| 64 | + # Default: charts |
| 65 | + repository: "" |
| 66 | + |
| 67 | + # How long to wait for installed charts to be healthy before failing |
| 68 | + # Default: 3m |
| 69 | + helm-install-wait-timeout: "" |
| 70 | + |
| 71 | + # Other git repos in this organization to clone and run skaffold for. Should be a |
| 72 | + # comma separated list of short repository names, excluding the organization |
| 73 | + # Default: |
| 74 | + dependencies: "" |
| 75 | + |
| 76 | + # Seconds to sleep before running tests |
| 77 | + # Default: 10 |
| 78 | + sleep: "" |
| 79 | + |
| 80 | + # Helm repository name to add |
| 81 | + # Default: unsupervised |
| 82 | + helm-repo-name: "" |
| 83 | + |
| 84 | + # Helm repository url |
| 85 | + # Default: https://raw.githubusercontent.com/${{ github.repository_owner }}/charts/main |
| 86 | + helm-repo-url: "" |
| 87 | + |
| 88 | + # Helm repository username |
| 89 | + # Default: |
| 90 | + helm-repo-username: "" |
| 91 | + |
| 92 | + # Helm repository password |
| 93 | + # Default: |
| 94 | + helm-repo-password: "" |
21 | 95 | ``` |
22 | 96 |
|
23 | 97 | <!-- end usage --> |
24 | 98 | <!-- start inputs --> |
25 | 99 |
|
26 | | -| **Input** | **Description** | **Default** | **Required** | |
27 | | -| :----------------- | :-------------- | :---------: | :----------: | |
28 | | -| **`who-to-greet`** | Who to greet | `World` | **true** | |
| 100 | +| **Input** | **Description** | **Default** | **Required** | |
| 101 | +| :------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------: | :----------: | |
| 102 | +| **`token`** | Github token, if there are dependencies, this should be a PAT so that the other repos can be cloned | `${{ github.token }}` | **false** | |
| 103 | +| **`ref`** | Git ref to use | `${{ github.ref }}` | **false** | |
| 104 | +| **`test-command`** | What test command to run | `go test` | **false** | |
| 105 | +| **`test-working-directory`** | Directory to run tests from | `test` | **false** | |
| 106 | +| **`wait-for-ports`** | Ports to wait for, used for dependent charts, if those charts need exposed local ports as part of testing. Comma separated list such as `8000,8001` | | **false** | |
| 107 | +| **`max-wait`** | Max time in milliseconds to wait for readiness on ports set in `wait-for-ports` | `300000` | **false** | |
| 108 | +| **`check-interval`** | Interval to check readiness on ports set in `wait-for-ports` | `5000` | **false** | |
| 109 | +| **`helm-charts`** | Helm charts to install, a json formatted string, that is a list of objects | `[]` | **false** | |
| 110 | +| **`credentials-json`** | Gcloud service account credentials json. This is required if you are installing helm charts | | **false** | |
| 111 | +| **`project-id`** | gcloud project id. This is required if you are installing helm charts | | **false** | |
| 112 | +| **`region`** | artifact registry region | `us-west1` | **false** | |
| 113 | +| **`repository`** | artifact registry repository | `charts` | **false** | |
| 114 | +| **`helm-install-wait-timeout`** | How long to wait for installed charts to be healthy before failing | `3m` | **false** | |
| 115 | +| **`dependencies`** | Other git repos in this organization to clone and run skaffold for. Should be a comma separated list of short repository names, excluding the organization | | **false** | |
| 116 | +| **`sleep`** | Seconds to sleep before running tests | `10` | **false** | |
| 117 | +| **`helm-repo-name`** | Helm repository name to add | `unsupervised` | **false** | |
| 118 | +| **`helm-repo-url`** | Helm repository url | `https://raw.githubusercontent.com/${{ github.repository_owner }}/charts/main` | **false** | |
| 119 | +| **`helm-repo-username`** | Helm repository username | | **false** | |
| 120 | +| **`helm-repo-password`** | Helm repository password | | **false** | |
29 | 121 |
|
30 | 122 | <!-- end inputs --> |
31 | 123 | <!-- start outputs --> |
|
0 commit comments