pandaswhocode/Initialize GitHub Job

Common steps for initializing a job for GitHub actions

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
egress-policyEgress policy to apply to the runner (audit or block)noaudit
checkoutWhether to checkout the repositoryno
checkout-refThe branch, tag or SHA to checkoutno
checkout-tokenPersonal access token (PAT) used to fetch the repository and set up taskno
checkout-pathThe path to checkout the repository into (relative to ${GITHUB_WORKSPACE})no.
checkout-fetch-depthDepth of commit history to fetchno1
checkout-persistWhether to configure the token with the local git confignotrue
checkout-submodulesWhether to checkout submodules (true/false/recursive)nofalse
checkout-sparseDo a sparse checkout on given patterns. Each pattern should be separated with new lines. no
checkout-sparse-cone-modeSpecifies whether to use cone-mode when doing a sparse checkout. notrue
setup-nodeWhether to setup Node.jsno
node-versionNode.js version to useno
node-cacheUsed to specify a package manager for caching (npm, yarn, pnpm)no
node-check-latestWhether to check for the latest Node.js versionno
node-registryThe registry URL to use for Node.js package installation and publishingno
setup-javaWhether to setup Javano
java-versionJava version to useno
java-distributionJava distribution (temurin, zulu, adopt, etc.)no
java-cacheName of the build platform to cache dependencies. It can be "maven", "gradle" or "sbt".no
setup-gradleWhether to setup Gradleno
gradle-versionGradle version to use. If specified, this Gradle version will be downloaded, added to the PATH and used for invoking Gradle.nowrapper
gradle-cache-disabledWhether to disable Gradle cachingnofalse
gradle-cache-read-onlyWhether to use read-only caching for Gradleno
cache-write-onlyWhen true, entries will not be restored from the cache but will be saved at the end of the Job.nofalse
setup-testlensWhether to setup TestLensno
testlens-write-log-filesWhether to instruct TestLens to write log files about its activitynofalse
setup-pythonWhether to setup Pythonno
python-versionPython version to useno
python-cacheUsed to specify a package manager for caching (pip, pipenv, poetry)no
setup-goWhether to setup Gono
go-versionGo version to useno
go-cacheWhether to cache Go modulesnotrue
go-architectureTarget architecture for Go to use. Examples: x86, x64. Will use system architecture by default.no
setup-rustWhether to setup Rustno
rust-versionRust version to useno
rust-targetsComma-separated list of target triples to install for this toolchainno
rust-componentsComma-separated list of components to be additionally installedno
setup-swiftWhether to setup Swiftno
swift-versionSwift version to useno
swift-cacheWhether to cache downloaded toolchain snapshots. Enabled by default, can be disabled in case of storage constraints.notrue
swift-prefer-oss-toolchainWhether to prefer installing Swift open source toolchain over using Xcode integrated toolchain.nofalse
swift-sdksSemi-colon separated list of Swift SDKs to install along with the main toolchain.no
setup-taskWhether to setup Tasknofalse
setup-gomplateWhether to setup gomplatenofalse
gomplate-versionGomplate version to use (e.g. v5.0.0)nov5.0.0
task-versionTask version to useno3.50.0
task-retriesNumber of retries for Task setup in case of failure, default is 3.no3
setup-jqWhether to setup jqnofalse
jq-versionDesired jq version (e.g. 1.8.1)no1.8.1
setup-semverWhether to setup semver toolnofalse
setup-deterministic-zipWhether to setup deterministic-zipnofalse
namedescription
checkout-refThe branch, tag or SHA that was checked out
checkout-commitThe commit SHA that was checked out
java-distributionDistribution of Java that has been installed
java-versionActual version of the java environment that has been installed
java-pathPath to where the java environment has been installed (same as $JAVA_HOME)
java-cache-hitA boolean value to indicate an exact match was found for the primary key
gradle-build-scan-urlLink to the Build Scan® generated by a Gradle build. Note that this output applies to a Step executing Gradle, not to the `setup-gradle` Step itself.
gradle-dependency-graph-filePath to the GitHub Dependency Graph snapshot file generated by a Gradle build. Note that this output applies to a Step executing Gradle, not to the `setup-gradle` Step itself.
gradle-versionVersion of Gradle that was setup by the action
node-cache-hitA boolean value to indicate if a cache was hit.
node-versionThe installed node version.
node-registry-urlThe registry URL used for package installation and publishing.
python-versionThe installed Python or PyPy version. Useful when given a version range as input.
python-cache-hitA boolean value to indicate a cache entry was found
python-pathThe absolute path to the Python or PyPy executable.
go-versionThe installed Go version. Useful when given a version range as input.
go-cache-hitA boolean value to indicate if a cache was hit
rust-cachekeyA short hash of the rustc version, appropriate for use as a cache key. "20220627a831"
rust-nameRustups name for the selected version of the toolchain. "1.62.0"
swift-versionThe actual Swift version that was configured.
swift-toolchainJSON formatted toolchain snapshot metadata that was configured.
swift-sdksJSON formatted SDK snapshots metadata that were configured.
semver-versionThe installed semver version.