GitHub Action - Setup xmake

Set up your GitHub Actions workflow with a specific version of xmake

Usage

See action.yml.

Example

Use latest version

uses: xmake-io/github-action-setup-xmake@v1
with:
  xmake-version: latest

Use specified version

uses: xmake-io/github-action-setup-xmake@v1
with:
  xmake-version: '2.5.3'

Use specified branch

uses: xmake-io/github-action-setup-xmake@v1
with:
  xmake-version: branch@master

Use semver

uses: xmake-io/github-action-setup-xmake@v1
with:
  xmake-version: '>=2.2.6 <=2.5.3'

Cache xmake

uses: xmake-io/github-action-setup-xmake@v1
with:
  xmake-version: '2.9.7'
  actions-cache-folder: '.xmake-cache'

Cache xmake with cachekey

uses: xmake-io/github-action-setup-xmake@v1
with:
  xmake-version: '2.9.7'
  actions-cache-folder: '.xmake-cache'
  actions-cache-key: 'archlinux-ci'

Cache packages

uses: xmake-io/github-action-setup-xmake@v1
with:
  xmake-version: '2.9.7'
  package-cache: true
  package-cache-key: 'archlinux-ci'
  project-path: 'myproject' # we need to compute packages hashkey for project

Cache build

By default, xmake disables build cache when building on ci, so we need to enable it first.

$ xmake f --policies=build.ccache:y

And xmake v2.9.8 will enable it by default if action/build-cache is enabled.

uses: xmake-io/github-action-setup-xmake@v1
with:
  xmake-version: '2.9.7'
  build-cache: true
  build-cache-key: 'archlinux-ci'

Cache build with the specific project path.

uses: xmake-io/github-action-setup-xmake@v1
with:
  xmake-version: '2.9.7'
  build-cache: true
  project-path: 'myproject' # we can get the build cache path from project.

Cache build with the specific build path.

uses: xmake-io/github-action-setup-xmake@v1
with:
  xmake-version: '2.9.7'
  build-cache: true
  build-cache-path: 'build/.build_cache'

Contributing

Prepare development environment

pnpm install

Draft a new release

pnpm release
git add .
git commit -m "build: release"
pnpm version [new-version]

# for a minor version or patch of v1
git tag --delete v1
git tag v1

git push origin master
git push --tags --force

Development and debug

git branch test
git checkout test
pnpm build
pnpm release
git-commit -a -m "..."
git push origin test