1 Commits
Author SHA1 Message Date
GitHub Action b7246b12e7 build 2024-03-01 16:46:38 +00:00
24 changed files with 34244 additions and 27402 deletions
+1 -1
View File
@@ -1 +1 @@
* @Azure/cloud-native-github-action-owners
* @Azure/aks-atlanta
-18
View File
@@ -1,18 +0,0 @@
version: 2
updates:
- package-ecosystem: npm
directory: /
schedule:
interval: weekly
groups:
actions:
patterns:
- '*'
- package-ecosystem: github-actions
directory: .github/workflows
schedule:
interval: weekly
groups:
actions:
patterns:
- '*'
+15 -13
View File
@@ -10,24 +10,26 @@ jobs:
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- uses: actions/stale@4391f3da665fdf50b6810c1a66712fb9ba21aa93 #v11.0.0
name: Mark idle issues and PRs and close inactive ones
- uses: actions/stale@v9
name: Setting issue as idle
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'This issue is idle after 60 days with no activity. It will be closed in 14 days if there is no further activity.'
stale-issue-message: 'This issue is idle because it has been open for 14 days with no activity.'
stale-issue-label: 'idle'
close-issue-message: 'Closing this issue after 14 more days with no activity since it was marked idle.'
stale-pr-message: 'This PR is idle after 60 days with no activity. It will be closed in 14 days if there is no further activity.'
stale-pr-label: 'idle'
close-pr-message: 'Closing this PR after 14 more days with no activity since it was marked idle.'
days-before-stale: 60
days-before-close: 14
remove-stale-when-updated: true
days-before-stale: 14
days-before-close: -1
operations-per-run: 100
exempt-issue-labels: 'backlog'
- uses: actions/stale@v9
name: Setting PR as idle
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-pr-message: 'This PR is idle because it has been open for 14 days with no activity.'
stale-pr-label: 'idle'
days-before-stale: 14
days-before-close: -1
operations-per-run: 100
+25 -28
View File
@@ -7,22 +7,15 @@ on:
jobs:
trigger-integration-tests:
name: Trigger Integration tests
strategy:
matrix:
os:
- ubuntu-latest
- ubuntu-24.04-arm
- macos-latest # arm
fail-fast: false
runs-on: ${{ matrix.os }}
runs-on: ubuntu-latest
env:
HELM_3_18_4: 'v3.18.4'
HELM_3_18_0: 'v3.18.0'
HELM_NO_V: '3.18.4'
HELM_3_8_0: 'v3.8.0'
HELM_3_7_2: 'v3.7.2'
HELM_NO_V: '3.5.0'
PR_BASE_REF: ${{ github.event.pull_request.base.ref }}
steps:
- name: Check out repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
uses: actions/checkout@v4
- name: npm install and build
id: action-npm-build
run: |
@@ -34,41 +27,41 @@ jobs:
- name: Setup helm
uses: ./
with:
version: ${{ env.HELM_3_18_4 }}
- name: Validate helm 3.18.4
version: ${{ env.HELM_3_8_0 }}
- name: Validate helm 3.8.0
run: |
if [[ $(helm version) != *$HELM_3_18_4* ]]; then
echo "HELM VERSION INCORRECT: HELM VERSION DOES NOT CONTAIN v3.18.4"
if [[ $(helm version) != *$HELM_3_8_0* ]]; then
echo "HELM VERSION INCORRECT: HELM VERSION DOES NOT CONTAIN v3.8.0"
echo "HELM VERSION OUTPUT: $(helm version)"
exit 1
else
echo "HELM VERSION $HELM_3_18_4 INSTALLED SUCCESSFULLY"
echo "HELM VERSION $HELM_3_8_0 INSTALLED SUCCESSFULLY"
fi
- name: Setup helm 3.18.0
- name: Setup helm 3.7.2
uses: ./
with:
version: ${{ env.HELM_3_18_0 }}
- name: Validate 3.18.0
version: ${{ env.HELM_3_7_2 }}
- name: Validate 3.7.2
run: |
if [[ $(helm version) != *$HELM_3_18_0* ]]; then
echo "HELM VERSION INCORRECT: HELM VERSION DOES NOT CONTAIN v3.18.0"
if [[ $(helm version) != *$HELM_3_7_2* ]]; then
echo "HELM VERSION INCORRECT: HELM VERSION DOES NOT CONTAIN v3.7.2"
echo "HELM VERSION OUTPUT: $(helm version)"
exit 1
else
echo "HELM VERSION $HELM_3_18_0 INSTALLED SUCCESSFULLY"
echo "HELM VERSION $HELM_3_7_2 INSTALLED SUCCESSFULLY"
fi
- name: Setup helm 3.18.4 with no v in version
- name: Setup helm 3.5.0 with no v in version
uses: ./
with:
version: ${{ env.HELM_NO_V }}
- name: Validate 3.18.4 without v in version
- name: Validate 3.5.0 without v in version
run: |
if [[ $(helm version) != *$HELM_NO_V* ]]; then
echo "HELM VERSION INCORRECT: HELM VERSION DOES NOT CONTAIN 3.18.4"
echo "HELM VERSION INCORRECT: HELM VERSION DOES NOT CONTAIN v3.5.0"
echo "HELM VERSION OUTPUT: $(helm version)"
exit 1
else
echo "HELM VERSION $HELM_NO_V INSTALLED SUCCESSFULLY"
echo "HELM VERSION $HELM_3_5_0 INSTALLED SUCCESSFULLY"
fi
- name: Setup helm latest version
uses: ./
@@ -79,7 +72,11 @@ jobs:
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
HELM_LATEST=$(curl -s https://get.helm.sh/helm-latest-version)
HELM_LATEST=$(gh release list \
--repo helm/helm \
--exclude-drafts \
--exclude-pre-releases \
--limit 1 | awk '{print $4}')
if [[ $(helm version) != *$HELM_LATEST* ]]; then
echo "HELM VERSION INCORRECT: HELM VERSION DOES NOT CONTAIN $HELM_LATEST"
+4 -2
View File
@@ -10,7 +10,9 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
uses: actions/checkout@v4
- name: Enforce Prettier
run: npx prettier --check .
uses: actionsx/prettier@v3
with:
args: --check .
+1 -1
View File
@@ -13,6 +13,6 @@ jobs:
permissions:
actions: read
contents: write
uses: Azure/action-release-workflows/.github/workflows/release_js_project.yaml@a391b701462581f586d0e8a68e60b04aa47dc4a9 # v1.2.0
uses: Azure/action-release-workflows/.github/workflows/release_js_project.yaml@a705b2ab6a3ee889f2b0d925ad0bd2f9eb733ce6
with:
changelogPath: ./CHANGELOG.md
+10
View File
@@ -0,0 +1,10 @@
name: Tag and create release draft
on:
push:
branches:
- releases/*
jobs:
tag-and-release:
uses: OliverMKing/javascript-release-workflow/.github/workflows/tag-and-release.yml@main
+2 -11
View File
@@ -11,18 +11,9 @@ on: # rebuild any PRs and main branch changes
jobs:
build: # make sure build/ci works properly
strategy:
matrix:
os:
- ubuntu-latest
- ubuntu-24.04-arm
- windows-latest
- windows-11-arm
- macos-latest # arm
fail-fast: false
runs-on: ${{ matrix.os }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- uses: actions/checkout@v4
- name: Run L0 tests.
run: |
-3
View File
@@ -62,6 +62,3 @@ node_modules
coverage
# Transpiled JS
# Planning docs
docs/
-7
View File
@@ -1,7 +0,0 @@
npm test
npm run format-check || {
echo ""
echo "❌ Formatting check failed."
echo "💡 Run 'npm run format' or 'prettier --write .' to fix formatting issues."
exit 1
}
+2 -103
View File
@@ -1,110 +1,9 @@
# Change Log
## [5.1.0] - 2026-11-09
### Added
- #281 [Read the Helm version from a .tool-versions file with the version-file input](https://github.com/Azure/setup-helm/pull/281)
- #293 [Resolve the latest patch for a major.minor version](https://github.com/Azure/setup-helm/pull/293)
- #315 [Add configurable checksum verification and fallback download mirrors](https://github.com/Azure/setup-helm/pull/315)
### Fixed
- #292 [Preserve subpath base URLs when constructing Helm download URLs](https://github.com/Azure/setup-helm/pull/292)
- #303 [Retry latest-version lookups and add the latest-fallback opt-out](https://github.com/Azure/setup-helm/pull/303)
### Security
- #313 [Update Undici security fixes](https://github.com/Azure/setup-helm/pull/313)
- #307 [Update Undici](https://github.com/Azure/setup-helm/pull/307)
- #298 [Update Undici](https://github.com/Azure/setup-helm/pull/298)
### Changed
- #314 [Update the built-in Helm fallback from v3.18.4 to v4.3.1](https://github.com/Azure/setup-helm/pull/314)
- #311 [Enable stale cleanup after 74 inactive days](https://github.com/Azure/setup-helm/pull/311)
- #306 [Update the shared release workflow](https://github.com/Azure/setup-helm/pull/306)
- Update remaining dependency groups, development tools, and workflow actions (#290, #291, #294, #295, #297, #299, #301, #305, #308, #309, #316)
## [5.0.1] - 2026-06-23
### Fixed
- #271 [Fix TypeScript 6.0 compatibility errors in run.ts](https://github.com/Azure/setup-helm/pull/271)
- #278 [fix: use chmod 755 instead of 777 for downloaded helm binary and folder](https://github.com/Azure/setup-helm/pull/278)
### Changed
- #286 [Bump actions/checkout from 6.0.3 to 7.0.0 in /.github/workflows in the actions group](https://github.com/Azure/setup-helm/pull/286)
- #285 [Bump the actions group with 2 updates](https://github.com/Azure/setup-helm/pull/285)
- #284 [Bump undici](https://github.com/Azure/setup-helm/pull/284)
- #283 [Bump the actions group with 5 updates](https://github.com/Azure/setup-helm/pull/283)
- #280 [Bump actions/checkout from 6.0.2 to 6.0.3 in /.github/workflows in the actions group](https://github.com/Azure/setup-helm/pull/280)
- #279 [Bump the actions group with 2 updates](https://github.com/Azure/setup-helm/pull/279)
- #277 [Bump vitest from 4.1.7 to 4.1.8 in the actions group](https://github.com/Azure/setup-helm/pull/277)
- #276 [chore: remove deprecated OliverMKing release workflow, pin to SHA](https://github.com/Azure/setup-helm/pull/276)
- #275 [Bump actions/stale from 10.2.0 to 10.3.0 in /.github/workflows in the actions group](https://github.com/Azure/setup-helm/pull/275)
- #274 [Bump the actions group with 3 updates](https://github.com/Azure/setup-helm/pull/274)
- #273 [Bump the actions group with 2 updates](https://github.com/Azure/setup-helm/pull/273)
- #269 [Bump the actions group across 1 directory with 7 updates](https://github.com/Azure/setup-helm/pull/269)
- #268 [Bump vite from 8.0.0 to 8.0.5](https://github.com/Azure/setup-helm/pull/268)
- #260 [Migrate to ESM with esbuild/vitest and upgrade to node24 (v5.0.0)](https://github.com/Azure/setup-helm/pull/260)
## [5.0.0] - 2026-03-23
### Changed
- #259 [Update Node.js runtime from node20 to node24](https://github.com/Azure/setup-helm/pull/259)
- #263 [Bump undici](https://github.com/Azure/setup-helm/pull/263)
- #257 [Bump undici and @actions/http-client](https://github.com/Azure/setup-helm/pull/257)
- #256 [Bump minimatch](https://github.com/Azure/setup-helm/pull/256)
- #248 [Bump the actions group with 2 updates](https://github.com/Azure/setup-helm/pull/248)
- #247 [Bump the actions group with 3 updates](https://github.com/Azure/setup-helm/pull/247)
- #246 [Bump @types/node from 25.0.2 to 25.0.3 in the actions group](https://github.com/Azure/setup-helm/pull/246)
- #245 [Bump the actions group with 3 updates](https://github.com/Azure/setup-helm/pull/245)
- #243 [Bump the actions group with 2 updates](https://github.com/Azure/setup-helm/pull/243)
- #240 [Bump prettier from 3.6.2 to 3.7.3 in the actions group](https://github.com/Azure/setup-helm/pull/240)
- #229 [Bump the actions group across 1 directory with 3 updates](https://github.com/Azure/setup-helm/pull/229)
- #231 [Bump js-yaml from 3.14.1 to 3.14.2](https://github.com/Azure/setup-helm/pull/231)
- #234 [Bump glob from 10.4.5 to 10.5.0](https://github.com/Azure/setup-helm/pull/234)
- #225 [Fix build error](https://github.com/Azure/setup-helm/pull/225)
- #222 [Bump @types/node from 24.7.2 to 24.8.1 in the actions group](https://github.com/Azure/setup-helm/pull/222)
- #220 [Bump the actions group across 1 directory with 4 updates](https://github.com/Azure/setup-helm/pull/220)
- #216 [Bump the actions group across 1 directory with 4 updates](https://github.com/Azure/setup-helm/pull/216)
- #213 [Bump the actions group with 2 updates](https://github.com/Azure/setup-helm/pull/213)
- #211 [Bump undici](https://github.com/Azure/setup-helm/pull/211)
- #212 [Bump jest from 30.0.5 to 30.1.2 in the actions group](https://github.com/Azure/setup-helm/pull/212)
- #210 [Bump @types/node from 24.2.1 to 24.3.0 in the actions group](https://github.com/Azure/setup-helm/pull/210)
## [4.3.1] - 2025-08-12
### Changed
- #167 [Pinning Action Dependencies for Security and Reliability](https://github.com/Azure/setup-helm/pull/167)
- #181 [Fix types, and update node version.](https://github.com/Azure/setup-helm/pull/181)
- #191 [chore(tests): Mock arch to make tests pass on arm host](https://github.com/Azure/setup-helm/pull/191)
- #192 [chore: remove unnecessary prebuild script](https://github.com/Azure/setup-helm/pull/192)
- #203 [Update helm version retrieval to use JSON output for latest version](https://github.com/Azure/setup-helm/pull/203)
- #207 [ci(workflows): update helm version to v3.18.4 and add matrix for tests](https://github.com/Azure/setup-helm/pull/207)
### Added
- #197 [Add pre-commit hook](https://github.com/Azure/setup-helm/pull/197)
## [4.3.0] - 2025-02-15
- #152 feat: log when restoring from cache
- #157 Dependencies Update
- #137 Add dependabot
## [4.2.0] - 2024-04-15
- #124 Fix OS detection and download OS-native archive extension
## [4.1.0] - 2024-03-01
- #130 switches to use Helm published file to read latest version instead of using GitHub releases
- #130 switches to use Helm published file to read latest version instead of using GitHub releases
## [4.0.0] - 2024-02-12
- #121 update to node20 as node16 is deprecated
- #121 update to node20 as node16 is deprecated
+3 -3
View File
@@ -4,6 +4,6 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
Resources:
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
+3 -54
View File
@@ -4,68 +4,17 @@ Install a specific version of helm binary on the runner.
## Example
Acceptable values are `latest` or any semantic version string such as `v4.3.1`. The `latest` value follows Helm's current stable release and can change major versions.
Acceptable values are latest or any semantic version string like v3.5.0 Use this action in workflow to define which version of helm will be used. v2+ of this action only support Helm3.
```yaml
- uses: azure/setup-helm@v5
- uses: azure/setup-helm@v4.1.0
with:
version: '<version>' # default is latest (stable)
id: install
```
Alternatively, the version can be read from a [`.tool-versions`](https://asdf-vm.com/manage/configuration.html) file (the format used by [asdf](https://asdf-vm.com/) and [mise](https://mise.jdx.dev/)) via the `version-file` input:
```yaml
- uses: azure/setup-helm@v5.0.0
with:
version-file: .tool-versions
id: install
```
The action reads the version declared for the `helm` tool, for example:
```
helm 4.3.1
```
If both `version` and `version-file` are set, an explicitly requested `version` takes precedence and `version-file` is ignored (a warning is emitted). Because `version` defaults to `latest`, `version-file` is only ignored when you set `version` to a specific value other than `latest`; if `version` is left at its default, the version from `version-file` is used.
> [!NOTE]
> If fetching the latest version fails, the action retries a few times and then uses the built-in fallback version (currently v4.3.1). This is a last-known stable version and can become a major version behind what `latest` resolves to. To fail the step with the underlying error instead, set `latest-fallback` to `'false'`:
>
> ```yaml
> - uses: azure/setup-helm@v5
> with:
> version: 'latest'
> latest-fallback: 'false'
> ```
>
> If you rely on a certain version, you should explicitly request that version instead of `latest`.
Freshly downloaded Helm archives are verified against the SHA-256 checksum published beside the archive before extraction. With the default `checksum-policy: auto`, the action verifies a matching checksum when one is available as a bare 64-character hexadecimal digest at `<archive-url>.sha256`; when the checksum is not found, the action warns and continues downloading. Existing tool-cache entries continue to be reused without downloading or re-verifying the archive.
Set `checksum-policy` to control this behavior:
- `auto` (default): verify checksums when available and warn when they are absent.
- `required`: require a valid matching checksum from every download location.
- `if-available`: explicitly select the same verify-or-warn behavior as `auto`.
- `disabled`: skip checksum verification and emit a warning.
Malformed or mismatched checksums always fail unless verification is explicitly `disabled`. In `if-available` and `auto` modes, only a checksum response of HTTP 404 or 410 is treated as absent; other download errors fail closed.
Because each checksum is retrieved from the same mirror as its archive, verification detects corruption or an incomplete mirror sync; it does not protect against a mirror that has been compromised together with its checksum files.
An optional fallback mirror can be used when version resolution, archive download, or checksum verification fails against the primary location:
```yaml
- uses: azure/setup-helm@v5
with:
version: 'v4.3.1'
downloadBaseURL: 'https://primary.example/helm'
downloadBaseURLFallback: 'https://fallback.example/helm'
```
The fallback archive follows the same checksum policy as the primary mirror. This capability follows the use case proposed by @mvtavares in [#227](https://github.com/Azure/setup-helm/pull/227).
> If something goes wrong with fetching the latest version the action will use the hardcoded default stable version (currently v3.13.3). If you rely on a certain version higher than the default, you should explicitly use that version instead of latest.
The cached helm binary path is prepended to the PATH environment variable as well as stored in the helm-path output variable.
Refer to the action metadata file for details about all the inputs https://github.com/Azure/setup-helm/blob/master/action.yml
+7 -7
View File
@@ -18,13 +18,13 @@ You should receive a response within 24 hours. If for some reason you do not, pl
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
- Full paths of source file(s) related to the manifestation of the issue
- The location of the affected source code (tag/branch/commit or direct URL)
- Any special configuration required to reproduce the issue
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible)
- Impact of the issue, including how an attacker might exploit the issue
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
- Full paths of source file(s) related to the manifestation of the issue
- The location of the affected source code (tag/branch/commit or direct URL)
- Any special configuration required to reproduce the issue
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible)
- Impact of the issue, including how an attacker might exploit the issue
This information will help us triage your report more quickly.
+2 -17
View File
@@ -3,11 +3,8 @@ description: 'Install a specific version of helm binary. Acceptable values are l
inputs:
version:
description: 'Version of helm'
required: false
required: true
default: 'latest'
version-file:
description: 'Path to a .tool-versions file to read the helm version from'
required: false
token:
description: GitHub token. Used to be required to fetch the latest version
required: false
@@ -17,23 +14,11 @@ inputs:
description: 'Set the download base URL'
required: false
default: 'https://get.helm.sh'
downloadBaseURLFallback:
description: 'Fallback base URL used when version resolution, download, or checksum verification fails against downloadBaseURL'
required: false
default: ''
checksum-policy:
description: "Checksum verification policy: 'auto' verifies checksums when available and warns when absent; 'required' always requires them; 'if-available' is an explicit alias for auto behavior; 'disabled' skips verification"
required: false
default: 'auto'
latest-fallback:
description: "When 'version' is 'latest' and the latest version cannot be determined after retrying, install the built-in default version instead of failing. Set to 'false' to fail the step instead, since the built-in default can be a major version behind what 'latest' resolves to."
required: false
default: 'true'
outputs:
helm-path:
description: 'Path to the cached helm binary'
branding:
color: 'blue'
runs:
using: 'node24'
using: 'node20'
main: 'lib/index.js'
+18
View File
@@ -0,0 +1,18 @@
module.exports = {
clearMocks: true,
moduleFileExtensions: ['js', 'ts'],
testEnvironment: 'node',
testMatch: ['**/*.test.ts'],
transform: {
'^.+\\.ts$': 'ts-jest'
},
verbose: true,
coverageThreshold: {
global: {
branches: 0,
functions: 14,
lines: 27,
statements: 27
}
}
}
+30208 -23753
View File
File diff suppressed because one or more lines are too long
+3654 -1959
View File
File diff suppressed because it is too large Load Diff
+20 -20
View File
@@ -1,35 +1,35 @@
{
"name": "setuphelm",
"version": "5.1.0",
"version": "4.1.0",
"private": true,
"description": "Setup helm",
"author": "Anumita Shenoy",
"license": "MIT",
"type": "module",
"dependencies": {
"@actions/core": "^3.0.1",
"@actions/exec": "^3.0.0",
"@actions/io": "^3.0.2",
"@actions/tool-cache": "4.0.0",
"@octokit/action": "^8.0.4",
"semver": "^7.8.6"
"@actions/core": "^1.10.0",
"@actions/exec": "^1.1.1",
"@actions/io": "^1.1.2",
"@actions/tool-cache": "2.0.1",
"@octokit/action": "^6.0.7",
"ncc": "^0.3.6",
"semver": "^7.5.4"
},
"main": "lib/index.js",
"scripts": {
"build": "tsc --noEmit && esbuild src/index.ts --bundle --platform=node --target=node20 --format=esm --outfile=lib/index.js --banner:js=\"import { createRequire } from 'module';const require = createRequire(import.meta.url);\"",
"typecheck": "tsc --noEmit",
"test": "vitest run",
"test-coverage": "vitest run --coverage",
"prebuild": "npm i ncc",
"build": "ncc build src/run.ts -o lib",
"test": "jest",
"test-coverage": "jest --coverage",
"format": "prettier --write .",
"format-check": "prettier --check .",
"prepare": "husky"
"format-check": "prettier --check ."
},
"devDependencies": {
"@types/node": "^26.6.6",
"esbuild": "^0.28",
"husky": "^9.1.7",
"prettier": "^3.9.10",
"typescript": "^7.0.2",
"vitest": "^5"
"@types/jest": "^29.5.11",
"@types/node": "^20.11.8",
"@vercel/ncc": "^0.38.1",
"jest": "^29.7.0",
"prettier": "^3.2.5",
"ts-jest": "^29.1.2",
"typescript": "^5.3.3"
}
}
-4
View File
@@ -1,4 +0,0 @@
import {run} from './run.js'
import * as core from '@actions/core'
run().catch(core.setFailed)
+141 -935
View File
File diff suppressed because it is too large Load Diff
+68 -443
View File
@@ -1,85 +1,37 @@
// Copyright (c) Microsoft Corporation.
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
import * as os from 'os'
import * as path from 'path'
import * as util from 'util'
import * as fs from 'fs'
import {createHash} from 'crypto'
import * as toolCache from '@actions/tool-cache'
import * as core from '@actions/core'
const helmToolName = 'helm'
export const stableHelmVersion = 'v4.3.1'
export type ChecksumPolicy = 'auto' | 'required' | 'if-available' | 'disabled'
const stableHelmVersion = 'v3.13.3'
export async function run() {
let version = core.getInput('version')
const versionFile = core.getInput('version-file')
let version = core.getInput('version', {required: true})
if (versionFile) {
if (version && version !== 'latest') {
core.warning(
`Both 'version' and 'version-file' inputs are specified, only 'version' will be used.`
)
} else {
version = getVersionFromToolVersionsFile(versionFile)
core.info(`Resolved Helm version '${version}' from '${versionFile}'`)
}
if (version !== 'latest' && version[0] !== 'v') {
core.info('Getting latest Helm version')
version = getValidVersion(version)
}
if (!version) {
version = 'latest'
if (version.toLocaleLowerCase() === 'latest') {
version = await getLatestHelmVersion()
}
const downloadBaseURL = core.getInput('downloadBaseURL', {required: false})
const downloadBaseURLFallback = core.getInput('downloadBaseURLFallback', {
required: false
})
const checksumPolicy = getChecksumPolicy(
core.getInput('checksum-policy', {required: false})
)
if (version.toLocaleLowerCase() === 'latest') {
// Only an explicit 'false' turns the fallback off, matching the
// input's default.
const fallbackToDefault =
core.getInput('latest-fallback').toLowerCase() !== 'false'
version = await getLatestHelmVersion(fallbackToDefault)
} else if (isMajorMinorShaped(version)) {
try {
version = await resolveLatestPatchVersion(downloadBaseURL, version)
} catch (error) {
if (!downloadBaseURLFallback) {
throw error
}
core.warning(
`Unable to resolve the latest Helm patch from '${downloadBaseURL}': ${error instanceof Error ? error.message : String(error)}. Trying fallback '${downloadBaseURLFallback}'`
)
version = await resolveLatestPatchVersion(
downloadBaseURLFallback,
version
)
}
core.info(`Resolved latest patch Helm version to '${version}'`)
} else if (version[0] !== 'v') {
version = getValidVersion(version)
core.info(`Normalized Helm version to '${version}'`)
}
core.startGroup(`Installing ${version}`)
const cachedPath = await downloadHelm(
downloadBaseURL,
version,
downloadBaseURLFallback,
checksumPolicy
)
core.startGroup(`Downloading ${version}`)
const cachedPath = await downloadHelm(downloadBaseURL, version)
core.endGroup()
try {
if (!process.env['PATH']?.startsWith(path.dirname(cachedPath))) {
if (!process.env['PATH'].startsWith(path.dirname(cachedPath))) {
core.addPath(path.dirname(cachedPath))
}
} catch {
@@ -95,412 +47,83 @@ export function getValidVersion(version: string): string {
return 'v' + version
}
export function getChecksumPolicy(value: string): ChecksumPolicy {
const policy = value.trim().toLowerCase() || 'auto'
if (
policy !== 'auto' &&
policy !== 'required' &&
policy !== 'if-available' &&
policy !== 'disabled'
) {
throw new Error(
`Invalid checksum-policy '${value}'. Expected auto, required, if-available, or disabled`
)
}
return policy
}
// Matches a complete semantic version (major.minor.patch with optional
// pre-release / build metadata). This is the official regex suggested at
// https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
// with an added optional leading 'v' to accept Helm-style tags (e.g. 'v3.14.0').
const semVerShape =
/^v?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/
// Returns true when version looks like a semantic version
export function isSemVerShaped(version: string): boolean {
return semVerShape.test(version)
}
// Matches a major.minor version with an optional leading 'v' and either no
// patch component or a wildcard patch ('.x' / '.*'), e.g. '3.14', 'v3.14',
// '3.14.x', 'v3.14.*'.
const majorMinorShape = /^v?\d+\.\d+(?:\.[x*])?$/
// Returns true when version is a major.minor value (optionally with a wildcard
// patch such as '.x' or '.*')
export function isMajorMinorShaped(version: string): boolean {
return majorMinorShape.test(version)
}
// Reads a .tool-versions file and returns the helm version declared in it
export function getVersionFromToolVersionsFile(filePath: string): string {
if (!fs.existsSync(filePath)) {
throw new Error(`The version-file '${filePath}' does not exist`)
}
const content = fs.readFileSync(filePath, 'utf8')
const version = parseToolVersions(content)
if (!version) {
throw new Error(`No helm version found in '${filePath}'`)
}
if (!isSemVerShaped(version) && !isMajorMinorShaped(version)) {
throw new Error(
`The helm version '${version}' in '${filePath}' is not valid. Provide a full version (e.g. '3.14.0') or a major.minor version (e.g. '3.14' or '3.14.x')`
)
}
return version
}
// Parses .tool-versions content (asdf/mise format) and returns the first
// helm version, or an empty string when none is declared. Lines look like
// `helm 3.14.0`; comments (#) and blank lines are ignored.
export function parseToolVersions(content: string): string {
for (const line of content.split(/\r?\n/)) {
const trimmed = line.trim()
if (!trimmed || trimmed.startsWith('#')) {
continue
}
const [tool, version] = trimmed.split(/\s+/)
if (tool === helmToolName && version) {
return version
}
}
return ''
}
const latestVersionURL = 'https://get.helm.sh/helm-latest-version'
// Number of attempts made to fetch the latest version before giving up, and
// the wait before the second attempt (each further wait doubles the previous).
const latestVersionAttempts = 3
const latestVersionRetryDelayMs = 1000
// Fetches the latest helm version. A failed request or a non-2xx response is
// retried with a short backoff, so a single transient failure does not decide
// the outcome. Throws the last error once every attempt has failed.
export async function fetchLatestHelmVersion(): Promise<string> {
let delayMs = latestVersionRetryDelayMs
for (let attempt = 1; ; attempt++) {
try {
const response = await fetch(latestVersionURL)
if (!response.ok) {
// The body is never read, so cancel it to release the connection
// before the next attempt.
await response.body?.cancel()
throw new Error(
`Unexpected HTTP ${response.status} from ${latestVersionURL}`
)
}
return (await response.text()).trim()
} catch (err) {
if (attempt >= latestVersionAttempts) {
throw err
}
core.info(
`Attempt ${attempt} of ${latestVersionAttempts} to fetch the latest Helm version failed: ${err instanceof Error ? err.message : String(err)}. Retrying in ${delayMs}ms`
)
await new Promise((resolve) => setTimeout(resolve, delayMs))
delayMs *= 2
}
}
}
// Gets the latest helm version. When it cannot be determined, returns the
// built-in default version with a warning, or throws when fallbackToDefault
// is off. The default version can be a major behind what 'latest' resolves
// to, so the warning names the input that turns the fallback off.
export async function getLatestHelmVersion(
fallbackToDefault = true
): Promise<string> {
// Gets the latest helm version or returns a default stable if getting latest fails
export async function getLatestHelmVersion(): Promise<string> {
try {
return await fetchLatestHelmVersion()
const response = await fetch('https://get.helm.sh/helm-latest-version')
const release = (await response.text()).trim()
return release
} catch (err) {
const message = err instanceof Error ? err.message : String(err)
if (!fallbackToDefault) {
throw new Error(
`Unable to determine the latest Helm version: ${message}. Set 'latest-fallback' to 'true' to install the default version ${stableHelmVersion} instead, or request a specific version`
)
}
core.warning(
`Error while fetching latest Helm release: ${message}. Using default version ${stableHelmVersion}. Set 'latest-fallback' to 'false' to fail the step instead`
`Error while fetching latest Helm release: ${err.toString()}. Using default version ${stableHelmVersion}`
)
return stableHelmVersion
}
}
// Number of consecutive missing patches to probe before concluding the walk,
// and an upper bound to keep resolution from running unbounded.
const patchLookahead = 3
const maxPatch = 100
// Sends a HEAD request for the given version's download URL. Returns true when
// the artifact exists (2xx) and false only when it is definitively absent
// (404). Any other status (403/405/429/5xx, ...) and genuine network errors are
// thrown, so transient failures, rate-limiting, or a host that disallows HEAD
// are never mistaken for a missing patch.
export async function helmPatchExists(
baseURL: string,
version: string
): Promise<boolean> {
const url = getHelmDownloadURL(baseURL, version)
const response = await fetch(url, {method: 'HEAD'})
if (response.ok) {
return true
}
if (response.status === 404) {
return false
}
throw new Error(
`Unexpected HTTP ${response.status} while checking for Helm artifact at ${url}`
)
}
// Attempts to resolve the latest patch in a single request via the Azure Blob
// container-listing API that backs get.helm.sh. Returns the newest stable patch
// version, or null when the host does not support listing (any non-listing
// response, empty result, or error) so the caller can fall back to probing.
// Only 'major.minor.patch-<platform>' names are matched, so prereleases and
// sidecar files (.sha256, ...) are ignored.
export async function resolveLatestPatchViaListing(
baseURL: string,
major: string,
minor: string
): Promise<string | null> {
let body: string
try {
const listURL = new URL(baseURL)
listURL.searchParams.set('restype', 'container')
listURL.searchParams.set('comp', 'list')
listURL.searchParams.set('prefix', `helm-v${major}.${minor}.`)
const response = await fetch(listURL.toString())
if (!response.ok) {
return null
}
body = await response.text()
} catch {
return null
}
if (!body.includes('<EnumerationResults')) {
return null
}
const patchPattern = new RegExp(
`helm-v${major}\\.${minor}\\.(\\d+)-(?:darwin|linux|windows)`,
'g'
)
let latestPatch = -1
for (const match of body.matchAll(patchPattern)) {
const patch = Number(match[1])
if (patch > latestPatch) {
latestPatch = patch
}
}
if (latestPatch < 0) {
return null
}
return `v${major}.${minor}.${latestPatch}`
}
// Resolves a major.minor value (e.g. '3.14' or 'v3.14') to the newest available
// patch (e.g. 'v3.14.4'). Fast path: a single container-listing request (which
// get.helm.sh supports). When the host does not support listing, it falls back
// to probing the download host for sequential patches. Only 'major.minor.n'
// artifacts are considered, so prereleases are never selected.
export async function resolveLatestPatchVersion(
baseURL: string,
version: string
): Promise<string> {
const [major, minor] = (
version[0] === 'v' ? version.slice(1) : version
).split('.')
const listed = await resolveLatestPatchViaListing(baseURL, major, minor)
if (listed) {
return listed
}
if (!(await helmPatchExists(baseURL, `v${major}.${minor}.0`))) {
throw new Error(`No Helm releases found for ${major}.${minor}`)
}
let latestPatch = 0
let consecutiveMisses = 0
for (
let patch = 1;
patch <= maxPatch && consecutiveMisses < patchLookahead;
patch++
) {
if (await helmPatchExists(baseURL, `v${major}.${minor}.${patch}`)) {
latestPatch = patch
consecutiveMisses = 0
} else {
consecutiveMisses++
}
}
// The look-ahead is what should end the walk. Exhausting maxPatch without a
// trailing run of misses means the host answered 200 for every probe (e.g. a
// catch-all mirror), so the resolved version cannot be trusted.
if (consecutiveMisses < patchLookahead) {
throw new Error(
`Unable to resolve latest patch for ${major}.${minor} (exceeded ${maxPatch} probes)`
)
}
return `v${major}.${minor}.${latestPatch}`
}
export function getArch(): string {
return os.arch() === 'x64' ? 'amd64' : os.arch()
}
export function getPlatform(): string {
return os.platform() === 'win32' ? 'windows' : os.platform()
}
export function getArchiveExtension(): string {
return os.platform() === 'win32' ? 'zip' : 'tar.gz'
}
export function getExecutableExtension(): string {
return os.platform() === 'win32' ? '.exe' : ''
if (os.type().match(/^Win/)) {
return '.exe'
}
return ''
}
const LINUX = 'Linux'
const MAC_OS = 'Darwin'
const WINDOWS = 'Windows_NT'
const ARM64 = 'arm64'
export function getHelmDownloadURL(baseURL: string, version: string): string {
const urlPath = `helm-${version}-${getPlatform()}-${getArch()}.${getArchiveExtension()}`
// Ensure the base ends with '/' so a subpath mirror (e.g.
// 'https://example/kubernetes/helm') is preserved; otherwise URL resolution
// replaces the last path segment and points at the wrong location.
const base = baseURL.endsWith('/') ? baseURL : `${baseURL}/`
const url = new URL(urlPath, base)
const arch = os.arch()
const operatingSystem = os.type()
let urlPath = ''
switch (true) {
case operatingSystem == LINUX && arch == ARM64:
urlPath = util.format(`/helm-%s-linux-arm64.zip`, version)
break
case operatingSystem == LINUX:
urlPath = util.format(`/helm-%s-linux-amd64.zip`, version)
break
case operatingSystem == MAC_OS && arch == ARM64:
urlPath = util.format(`/helm-%s-darwin-arm64.zip`, version)
break
case operatingSystem == MAC_OS:
urlPath = util.format(`/helm-%s-darwin-amd64.zip`, version)
break
case operatingSystem == WINDOWS:
default:
urlPath = util.format(`/helm-%s-windows-amd64.zip`, version)
}
const url = new URL(urlPath, baseURL)
return url.toString()
}
export async function downloadAndVerifyHelm(
baseURL: string,
version: string,
policy: ChecksumPolicy = 'auto'
): Promise<string> {
const downloadURL = getHelmDownloadURL(baseURL, version)
const effectivePolicy = resolveChecksumPolicy(policy)
if (effectivePolicy === 'disabled') {
core.warning(
`Checksum verification is disabled for Helm downloads from '${baseURL}'`
)
return toolCache.downloadTool(downloadURL)
}
let checksum: string | undefined
try {
const checksumPath = await toolCache.downloadTool(`${downloadURL}.sha256`)
checksum = fs.readFileSync(checksumPath, 'utf8').trim()
} catch (error) {
if (
effectivePolicy === 'if-available' &&
isChecksumNotFoundError(error)
) {
core.warning(
`No SHA-256 checksum is available for ${downloadURL}; continuing without verification. Set checksum-policy to 'required' to fail instead.`
)
return toolCache.downloadTool(downloadURL)
}
throw error
}
if (!/^[a-fA-F0-9]{64}$/.test(checksum)) {
throw new Error(`Invalid SHA-256 checksum from ${downloadURL}.sha256`)
}
const archivePath = await toolCache.downloadTool(downloadURL)
const hash = createHash('sha256')
await new Promise<void>((resolve, reject) => {
const archive = fs.createReadStream(archivePath)
archive.on('data', (chunk) => hash.update(chunk))
archive.on('error', reject)
archive.on('end', resolve)
})
const actual = hash.digest('hex')
if (actual.toLowerCase() !== checksum.toLowerCase()) {
throw new Error(`SHA-256 checksum mismatch for ${downloadURL}`)
}
return archivePath
}
export function resolveChecksumPolicy(
policy: ChecksumPolicy
): Exclude<ChecksumPolicy, 'auto'> {
return policy === 'auto' ? 'if-available' : policy
}
function isChecksumNotFoundError(error: unknown): boolean {
return (
error instanceof toolCache.HTTPError &&
(error.httpStatusCode === 404 || error.httpStatusCode === 410)
)
}
export async function downloadHelm(
baseURL: string,
version: string,
fallbackBaseURL?: string,
checksumPolicy: ChecksumPolicy = 'auto'
version: string
): Promise<string> {
let cachedToolpath = toolCache.find(helmToolName, version)
if (cachedToolpath) {
core.info(`Restoring '${version}' from cache`)
} else {
core.info(`Downloading '${version}' from '${baseURL}'`)
if (!cachedToolpath) {
let helmDownloadPath
try {
helmDownloadPath = await downloadAndVerifyHelm(
baseURL,
version,
checksumPolicy
helmDownloadPath = await toolCache.downloadTool(
getHelmDownloadURL(baseURL, version)
)
} catch (error) {
if (fallbackBaseURL) {
core.warning(
`Unable to download and verify Helm from '${baseURL}': ${error instanceof Error ? error.message : String(error)}. Trying fallback '${fallbackBaseURL}'`
)
try {
helmDownloadPath = await downloadAndVerifyHelm(
fallbackBaseURL,
version,
checksumPolicy
)
} catch (fallbackError) {
throw new Error(
`Failed to download and verify Helm from '${baseURL}' and fallback '${fallbackBaseURL}': ${fallbackError instanceof Error ? fallbackError.message : String(fallbackError)}`
)
}
} else {
throw new Error(
`Failed to download and verify Helm from location ${getHelmDownloadURL(
baseURL,
version
)}: ${error instanceof Error ? error.message : String(error)}`
)
}
}
if (!helmDownloadPath) {
} catch (exception) {
throw new Error(
`Failed to download and verify Helm version '${version}'`
`Failed to download Helm from location ${getHelmDownloadURL(
baseURL,
version
)}`
)
}
fs.chmodSync(helmDownloadPath, '755')
const extractedPath =
getPlatform() === 'windows'
? await toolCache.extractZip(helmDownloadPath)
: await toolCache.extractTar(helmDownloadPath)
fs.chmodSync(helmDownloadPath, '777')
const unzipedHelmPath = await toolCache.extractZip(helmDownloadPath)
cachedToolpath = await toolCache.cacheDir(
extractedPath,
unzipedHelmPath,
helmToolName,
version
)
@@ -513,13 +136,13 @@ export async function downloadHelm(
)
}
fs.chmodSync(helmpath, '755')
fs.chmodSync(helmpath, '777')
return helmpath
}
export function findHelm(rootFolder: string): string {
fs.chmodSync(rootFolder, '755')
let filelist: string[] = []
fs.chmodSync(rootFolder, '777')
var filelist: string[] = []
walkSync(rootFolder, filelist, helmToolName + getExecutableExtension())
if (!filelist || filelist.length == 0) {
throw new Error(
@@ -530,8 +153,8 @@ export function findHelm(rootFolder: string): string {
}
}
export function walkSync(dir, filelist, fileToFind) {
const files = fs.readdirSync(dir)
export var walkSync = function (dir, filelist, fileToFind) {
var files = fs.readdirSync(dir)
filelist = filelist || []
files.forEach(function (file) {
if (fs.statSync(path.join(dir, file)).isDirectory()) {
@@ -545,3 +168,5 @@ export function walkSync(dir, filelist, fileToFind) {
})
return filelist
}
run().catch(core.setFailed)
+60 -10
View File
@@ -1,14 +1,64 @@
{
"compilerOptions": {
"target": "ES2020",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"rootDir": "./src",
"outDir": "./lib",
"noImplicitAny": false,
"skipLibCheck": true,
"noEmit": true,
"types": ["node", "vitest/globals"]
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es6" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
"module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./lib" /* Redirect output structure to the directory. */,
"rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
/* Strict Type-Checking Options */
//"strict": true, /* Enable all strict type-checking options. */
"noImplicitAny": false /* Raise error on expressions and declarations with an implied 'any' type. */,
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
// "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
"skipLibCheck": true
},
"exclude": ["node_modules", "**/*.test.ts", "vitest.config.ts"]
"exclude": ["node_modules", "**/*.test.ts"]
}
-10
View File
@@ -1,10 +0,0 @@
import {defineConfig} from 'vitest/config'
export default defineConfig({
test: {
globals: true,
environment: 'node',
include: ['**/*.test.ts'],
clearMocks: true
}
})