meilcli / setup-crystal-action

setup Crystal action for GitHub Actions.

setup-crystal-action

setup Crystal action for GitHub Actions.

Required

setup-crystal-action must execute on Linux or macOS, because I do not know usage that WSL on GitHub Actions.

Example

name: CI

on: 
  push:
    branches:    
    - master
  pull_request:
    branches:
    - master

jobs:
  example:
    runs-on: ubuntu-20.04
    steps:
      - uses: MeilCli/setup-crystal-action@v4
        with: 
          crystal_version: latest
          shards_version: latest
      - name: Run Crystal
        run: |
          echo 'puts "Hello Crystal"' > hello.cr
          crystal run hello.cr

You can also pin to a specific release version in the format @v4.x.x

input

• crystal_version
  • required
  • install crystal version
  • value: latest or version value, see crystal-lang/crystal
  • default: latest
  • warning:
    • latest sometimes cannot find crystal binary when immediately after release
• shards_version
  • required
  • install shards version
  • value: latest or skip or version value, see crystal-lang/shards
    • if set skip, not install shards
  • default: latest
• github_token
  • github token, using get GitHub Release of crystal-lang/crystal or crystal-lang/shards
  • default: ${{ github.token }}
• cache_mode
  • cache mode
  • value: none, tool-cache or cache
  • default: cache
  • tool-cache
    • using: @actions/tool-cache
    • works in most cases with Self-Hosted Runner
  • cache
    • using: @actions/cache
    • works the same as actions/cache
• cache_prefix
  • if selected cache on cache_mode, option that prefix of cache key
  • Recommended use when parallel jobs
• install_root
  • if selected none or cache on cache_mode, use directory that dicide at this option
  • default: ${{ runner.temp }}

output

• installed_crystal_json
  • installed json that GitHub Release Asset
• installed_shards_json
  • installed json that GitHub Release

Contributes

Could you want to contribute?

see Contributing.md

License

setup-crystal-action's Issues

I don't think "tool-cache" cacheDir is doing anything

Hi. I found your usage of "@actions/tool-cache" and it was very interesting to me, as it seems to promise caching of an action's downloads across different workflow runs. However, I noticed that it never gets any cache hits. For example, if you check an example run with "show timestamps", you will see that there is always a big delay before extracting the archive, so I think it's just downloading it every time. Did you ever see it being useful? After a long search I found that this is usable only for self-hosted runners, and also that a proper caching feature for JavaScript is missing.

Failed to build with Crystal 1.2.0

Hi!

Example https://github.com/mamantoha/zipstream/runs/3920159681?check_suite_focus=true

Run MeilCli/setup-crystal-action@v4
  with:
    crystal_version: latest
    shards_version: latest
    github_token: ***
    install_root: /Users/runner/work/_temp
Error: Cannot read property 'name' of undefined

It's because for Crystal 1.2.0 macOS archive called crystal-1.2.0-1-darwin-universal.tar.gz but this action is looking for crystal-1.2.0-1-darwin-x86_64.tar.gz - https://github.com/crystal-lang/crystal/releases

Please fix. Thanks!

GITHUB_TOKEN is not necessary

I think you can use octokit directly:

const { Octokit } = require('@octokit/rest');

const octokit = new Octokit();

response = await octokit.repos.getReleaseByTag......

Instead of

setup-crystal-action/src/setup_crystal.ts

Line 4 in af7cbe1

import * as octkit from "@actions/github";

setup-crystal-action/src/setup_crystal.ts

Lines 24 to 29 in af7cbe1

	const github = new octkit.GitHub(option.githubToken);
	let response: Response<
	ReposGetReleaseByTagResponse | ReposGetLatestReleaseResponse
	>;
	if (option.crystalVersion != "latest") {
	response = await github.repos.getReleaseByTag({

And then you don't need GITHUB_TOKEN