Merge branch 'master' into v1

Author: oprypin

.eslintrc.json

@@ -2,8 +2,7 @@
     "env": {
         "commonjs": true,
         "es6": true,
-        "node": true,
-        "jest": true
+        "node": true
     },
     "extends": "eslint:recommended",
     "globals": {

.github/workflows/main.yml

@@ -33,15 +33,19 @@ jobs:
         shell: bash
     steps:
       - uses: actions/checkout@v2
-      - run: npm install
+      - run: npm install --only=prod
       - uses: ./
         with: ${{ matrix.config }}
         id: install
+      - run: |
+          echo 'crystal "${{ steps.install.outputs.crystal }}" | shards "${{ steps.install.outputs.shards }}"'
 
       - run: |
           crystal eval 'puts "test" + "ing"' | grep 'testing'
       - run: |
-          crystal --version
+          '${{ steps.install.outputs.path }}/bin/crystal' --version
+      - run: |
+          ls '${{ steps.install.outputs.path }}/src/prelude.cr'
       - run: |
           v='${{ steps.install.outputs.crystal }}'
           crystal --version | grep "${v:0:9}"
@@ -70,14 +74,14 @@ jobs:
         if: ${{ contains(matrix.config.shards, '.') }}
       - run: |
           ! shards --version
-        if: ${{ matrix.config.shards == 'false' }}
+        if: ${{ contains(matrix.config.shards, 'false') }}
+      - run: |
+          shards build
+        working-directory: test-project
+        if: ${{ !contains('false', matrix.config.shards) }}
 
   test:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - run: npm install

.github/workflows/release.yml

@@ -33,15 +33,19 @@ jobs:
         shell: bash
     steps:
       - uses: actions/checkout@v2
-      - run: npm install
+      - run: npm install --only=prod
       - uses: oprypin/install-crystal@v1
         with: ${{ matrix.config }}
         id: install
+      - run: |
+          echo 'crystal "${{ steps.install.outputs.crystal }}" | shards "${{ steps.install.outputs.shards }}"'
 
       - run: |
           crystal eval 'puts "test" + "ing"' | grep 'testing'
       - run: |
-          crystal --version
+          '${{ steps.install.outputs.path }}/bin/crystal' --version
+      - run: |
+          ls '${{ steps.install.outputs.path }}/src/prelude.cr'
       - run: |
           v='${{ steps.install.outputs.crystal }}'
           crystal --version | grep "${v:0:9}"
@@ -70,4 +74,8 @@ jobs:
         if: ${{ contains(matrix.config.shards, '.') }}
       - run: |
           ! shards --version
-        if: ${{ matrix.config.shards == 'false' }}
+        if: ${{ contains(matrix.config.shards, 'false') }}
+      - run: |
+          shards build
+        working-directory: test-project
+        if: ${{ !contains('false', matrix.config.shards) }}

.gitignore

@@ -1 +1,2 @@
 node_modules/
+.vscode/

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Development guide
+
+## Trying it out locally
+
+### Example
+
+```bash
+tmp=$(mktemp -d) && touch "$tmp"/{path,env}
+export RUNNER_TEMP="$tmp" GITHUB_PATH="$tmp/path" GITHUB_ENV="$tmp/env"
+env PATH="$(pwd)/.tools:$PATH" INPUT_CRYSTAL=nightly INPUT_SHARDS=true INPUT_TOKEN="$personal_access_token" INSTALL_CRYSTAL_PLATFORM=win32 node index.js
+```
+
+## Pre-commit
+
+Make sure that `npm test` passes. A pre-commit hook is available: `git config core.hooksPath .tools/hooks`.
+
+## CI
+
+Continuous testing runs on GitHub Actions. Make sure that _.github/workflows/main.yml_ and _release.yml_ stay in sync, other than the differences that they already have.
+
+## Cutting a release
+
+Switch to _master_ branch, in a clean state. Run `.tools/release.sh x.y.z` (an actual next version number). You will be switched to the _v1_ branch, _node_modules_ will be populated, and a tag will be created. The final command to push all this will be only printed. Run it. After this, a release also needs to be published on GitHub Marketplace.
+
+### _node_modules_
+
+The _node_modules_ directory must not be present in the _master_ branch. _package-lock.json_ will be present, though.

README.md

@@ -1,12 +1,10 @@
 install-crystal
 ===============
 
-[GitHub Action][] to **install [Crystal][] programming language**
+[GitHub Action][] to **install [Crystal][] programming language** and [Shards][] package manager.
 
 Works on Ubuntu, macOS, Windows.
 
-On Ubuntu and macOS this also installs `shards`. This will be expanded in the future.
-
 ## Examples
 
 ```yaml
@@ -20,37 +18,80 @@ steps:
   - uses: actions/checkout@v2
   - uses: oprypin/install-crystal@v1
     with:
-      crystal: 0.34.0
+      crystal: 0.35.1
+  - run: shards install
   - run: crystal spec
 ```
 
+```yaml
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - {os: ubuntu-latest, crystal: latest}
+          - {os: ubuntu-latest, crystal: nightly}
+          - {os: macos-latest}
+          - {os: windows-latest}
+    runs-on: ${{matrix.os}}
+    steps:
+      - uses: oprypin/install-crystal@v1
+        with:
+          crystal: ${{matrix.crystal}}
+      - uses: actions/checkout@v2
+      - run: shards install
+      - run: crystal spec
+      - run: crystal tool format --check
+        if: matrix.crystal == 'latest'
+```
+
 [Find usages in the wild!](https://github.com/search?l=YAML&q=%22oprypin%2Finstall-crystal%22&type=Code)
 
-Alternatively, you can use the container-based approach [as in the starter workflow][crystal-starter] (without this action), but the advantage here is the unified approach to installation across 3 systems.
+Alternatively, you can use the container-based approach [as in the starter workflow][crystal-starter] (without this action), but the advantage here is the unified approach to installation across 3 systems. [Using a custom container has disadvantages on its own, too](https://forum.crystal-lang.org/t//2837).
 
 ## Usage
 
 ### Inputs
 
-* **`crystal: 0.34.0`** (not supported on Windows)
+* * **`crystal: 0.35.1`** (not supported on Windows)
+
+    Install a particular release of Crystal.
+
+  * **`crystal: latest`** (default; not supported on Windows)
+
+    Install the latest released version of Crystal.
+
+  * **`crystal: nightly`** (default on Windows)
+
+    Install Crystal from the latest continuous build on [crystal.git][] master.
 
-  Install a particular release of Crystal.
+* * **`shards: true`** (default)
 
-* **`crystal: latest`** (default; not supported on Windows)
+    Ensure that *some* released version of [Shards][] is available.
+    This uses the build that's bundled with Crystal's releases. Other options are slower, as building Shards is a necessary step then.
 
-  Install the latest released version of Crystal.
+  * **`shards: false`**
 
-* **`crystal: nightly`** (default on Windows)
+    Ensure that `shards` executable is *not* available.
 
-  Install Crystal from the latest continuous build on [crystal.git][] master.
+  * **`shards: latest`**
+
+    Build and install the latest released version of Shards.
+
+  * **`shards: 0.13.0`**
+
+    Build and install a particular release of Shards.
+
+  * **`shards: nightly`**
+
+    Build and install the latest commit of [shards.git][] master.
 
 * **`arch: x86_64`**, **`arch: x86`** (defaults to current OS arch)
 
   The architecture of the build of Crystal to download.
 
 * **`destination: some/path`**
 
-  The directory to store Crystal in, after extracting.
+  The directory to store Crystal in, after extracting. Will directly affect `outputs.path` (the default is in a temporary location).
 
 * **`token: ${{ github.token }}`**
 
@@ -62,8 +103,17 @@ Alternatively, you can use the container-based approach [as in the starter workf
 
   The actual version of Crystal (as a ref in crystal-lang/[crystal.git][]) that was installed.
 
+* **`shards`** (`${{ steps.some_step_id.outputs.shards }}`)
+
+  The actual version of Shards (as a ref in crystal-lang/[shards.git][]) that was installed.
+
+* **`path`** (`${{ steps.some_step_id.outputs.path }}`)
+
+  The path where Crystal was extracted to, so you can use '[path]/bin/crystal', '[path]/src' etc.
 
 [github action]: https://github.com/features/actions
 [crystal]: https://crystal-lang.org/
 [crystal.git]: https://github.com/crystal-lang/crystal
+[shards]: https://github.com/crystal-lang/shards
+[shards.git]: https://github.com/crystal-lang/shards
 [crystal-starter]: https://github.com/actions/starter-workflows/blob/master/ci/crystal.yml

action.yml

@@ -2,9 +2,9 @@ name: Install Crystal
 description: Install Crystal programming language
 inputs:
   crystal:
-    description: The version of Crystal to install ("latest", "nightly", "0.34.0" etc)
+    description: The version of Crystal to install ("latest", "nightly", "0.35.1" etc)
   shards:
-    description: The version of Shards to install (true, "latest", "nightly", "0.12.0" etc)
+    description: The version of Shards to install (true, "latest", "nightly", "0.13.0" etc)
   arch:
     description: The architecture of the build of Crystal ("x86_64")
   destination:
@@ -15,6 +15,10 @@ inputs:
 outputs:
   crystal:
     description: The actual version of Crystal that was installed
+  shards:
+    description: The actual version of Shards that was installed
+  path:
+    description: The directory where Crystal was installed
 runs:
   using: node12
   main: index.js