setup-pkl
GitHub Action[!CAUTION]
This GitHub Action is in PRE-RELEASE, meaning there may be unintended behaviour, and there is no guarantee of stability between versions. The major version is currently
v0
to reflect this.
This is a GitHub Action to install a binary for Pkl and add it to the PATH.
[!NOTE]
This is a project from the Pkl open-source community, and is not affiliated with Apple in any way.
steps:
- name: Install pkl
uses: pkl-community/setup-pkl@v0
with:
pkl-version: 0.25.2
pkl-version
- the Pkl version to use. It must be a valid tag from the
official Apple releasesgithub-token
- the GitHub token that will be used to download the Pkl binary
asset (this action uses the GitHub API to find the download link for the given
release). Defaults to ${{ github.token }}
, which should satisfy almost all
cases (as its being used to download a public asset)First clone the repository to your local machine. Then:
:twisted_rightwards_arrows: Use nvm
to select the right Node version
nvm use
:hammer_and_wrench: Install the dependencies
npm install
:building_construction: Package the TypeScript for distribution
npm run bundle
:white_check_mark: Run the tests
npm test
This action makes use of the GitHub Actions toolkit, see the documentation for more info.
This project includes a helper script, script/release
designed to streamline the process of tagging and pushing new releases for
GitHub Actions.
GitHub Actions allows users to select a specific version of the action to use, based on release tags. This script simplifies this process by performing the following steps: