Swap to GraphQL and add logging (#83)

* swap to graphql

* add logs

* swap to group log

* fix test
This commit is contained in:
Oliver King
2022-07-11 10:12:11 -04:00
committed by GitHub
parent 6e32762c2e
commit 484a64052d
3 changed files with 40 additions and 36 deletions

View File

@ -9,14 +9,16 @@ Acceptable values are latest or any semantic version string like v3.5.0 Use this
```yaml ```yaml
- uses: azure/setup-helm@v3 - uses: azure/setup-helm@v3
with: with:
version: '<version>' # default is latest stable version: '<version>' # default is latest (stable)
id: install id: install
``` ```
> Note: When using latest version you might hit the GitHub GraphQL API hourly rate limit of 5,000. The action will then return the hardcoded default stable version (currently v3.9.0). If you rely on a certain version higher than the default, you should 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. 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 Refer to the action metadata file for details about all the inputs https://github.com/Azure/setup-helm/blob/master/action.yml
# Contributing ## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us

View File

@ -74,12 +74,8 @@ describe('run.ts', () => {
expect(os.type).toBeCalled() expect(os.type).toBeCalled()
}) })
test('getLatestHelmVersion() - return the latest version of HELM', async () => { test('getLatestHelmVersion() - return the stable version of HELM since its not authenticated', async () => {
try { expect(await run.getLatestHelmVersion()).toBe('v3.9.0')
expect(await run.getLatestHelmVersion()).toBe('v3.8.0')
} catch (e) {
return e
}
}) })
test('walkSync() - return path to the all files matching fileToFind in dir', () => { test('walkSync() - return path to the all files matching fileToFind in dir', () => {

View File

@ -9,23 +9,25 @@ import * as fs from 'fs'
import * as toolCache from '@actions/tool-cache' import * as toolCache from '@actions/tool-cache'
import * as core from '@actions/core' import * as core from '@actions/core'
import {graphql} from '@octokit/graphql'
const helmToolName = 'helm' const helmToolName = 'helm'
const stableHelmVersion = 'v3.8.0' const stableHelmVersion = 'v3.9.0'
const helmAllReleasesUrl = 'https://api.github.com/repos/helm/helm/releases'
export async function run() { export async function run() {
let version = core.getInput('version', {required: true}) let version = core.getInput('version', {required: true})
if (version !== 'latest' && version[0] !== 'v') { if (version !== 'latest' && version[0] !== 'v') {
core.info('Getting latest Helm version')
version = getValidVersion(version) version = getValidVersion(version)
} }
if (version.toLocaleLowerCase() === 'latest') { if (version.toLocaleLowerCase() === 'latest') {
version = await getLatestHelmVersion() version = await getLatestHelmVersion()
} }
core.debug(util.format('Downloading %s', version)) core.startGroup(`Downloading ${version}`)
let cachedPath = await downloadHelm(version) const cachedPath = await downloadHelm(version)
core.endGroup()
try { try {
if (!process.env['PATH'].startsWith(path.dirname(cachedPath))) { if (!process.env['PATH'].startsWith(path.dirname(cachedPath))) {
@ -35,41 +37,46 @@ export async function run() {
//do nothing, set as output variable //do nothing, set as output variable
} }
console.log( core.info(`Helm tool version '${version}' has been cached at ${cachedPath}`)
`Helm tool version: '${version}' has been cached at ${cachedPath}`
)
core.setOutput('helm-path', cachedPath) core.setOutput('helm-path', cachedPath)
} }
//Returns version with proper v before it // Prefixes version with v
export function getValidVersion(version: string): string { export function getValidVersion(version: string): string {
return 'v' + version return 'v' + version
} }
// Downloads the helm releases JSON and parses all the recent versions of helm from it. // Gets the latest helm version or returns a default stable if getting latest fails
// Defaults to sending stable helm version if none are valid or if it fails
export async function getLatestHelmVersion(): Promise<string> { export async function getLatestHelmVersion(): Promise<string> {
const helmJSONPath: string = await toolCache.downloadTool(helmAllReleasesUrl)
try { try {
const helmJSON = JSON.parse(fs.readFileSync(helmJSONPath, 'utf-8')) const {repository} = await graphql(
for (let i in helmJSON) { `
if (isValidVersion(helmJSON[i].tag_name)) { {
return helmJSON[i].tag_name repository(name: "helm", owner: "helm") {
} releases(last: 100) {
} nodes {
tagName
}
}
}
}
`
)
const releases = repository.releases.nodes.reverse()
const latestValidRelease = releases.find((release: {tagName: string}) =>
isValidVersion(release.tagName)
)
if (latestValidRelease) return latestValidRelease
} catch (err) { } catch (err) {
core.warning( core.warning(
util.format( `Error while fetching latest Helm release: ${err.toString()}. Using default version ${stableHelmVersion}`
'Error while fetching the latest Helm release. Error: %s. Using default Helm version %s',
err.toString(),
stableHelmVersion
)
) )
return stableHelmVersion return stableHelmVersion
} }
core.warning(
`Could not find valid release. Using default version ${stableHelmVersion}`
)
return stableHelmVersion return stableHelmVersion
} }
@ -135,10 +142,9 @@ export async function downloadHelm(version: string): Promise<string> {
) )
} catch (exception) { } catch (exception) {
throw new Error( throw new Error(
util.format( `Failed to download Helm from location ${getHelmDownloadURL(
'Failed to download Helm from location', version
getHelmDownloadURL(version) )}`
)
) )
} }