Merge branch 'master' into v1

Author: oprypin

.eslintrc.json

@@ -4,6 +4,7 @@
         "es6": true,
         "node": true
     },
+    "ignorePatterns": ["docs/", "site/"],
     "extends": "eslint:recommended",
     "globals": {
         "Atomics": "readonly",

.github/workflows/deploy-docs.yml

@@ -0,0 +1,31 @@
+name: Deploy docs
+on:
+  push:
+    paths: ['docs/**', '*.md']
+  pull_request:
+    paths: ['docs/**', '*.md']
+    branches: [master]
+  schedule:
+    - cron: '0 6 * * 6'
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download source
+        uses: actions/checkout@v2
+      - name: Install Python
+        uses: actions/setup-python@v2
+      - name: Install dependencies
+        run: pip install -r docs/requirements.txt
+      - name: Fetch branch
+        run: git fetch origin v1:v1
+      - name: Build site
+        run: mkdocs build
+        working-directory: docs
+      - name: Deploy to gh-pages
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+        uses: oprypin/push-to-gh-pages@v3
+        with:
+          publish_dir: site
+          commit_message: 'Generate docs: '

.github/workflows/main.yml

@@ -2,8 +2,10 @@ name: CI
 
 on:
   push:
+    paths-ignore: ['docs/**', '*.md']
   pull_request:
-
+    paths-ignore: ['docs/**', '*.md']
+    branches: [master]
   schedule:
     - cron: '0 6 * * 6'
 
@@ -86,4 +88,4 @@ jobs:
       - uses: actions/checkout@v2
       - run: npm install
       - run: npm test
-      - run: npm audit --audit-level=moderate
+      - run: npm audit --audit-level=moderate --only=prod

.github/workflows/release.yml

@@ -2,8 +2,10 @@ name: CI (release)
 
 on:
   push:
-    branches:
-      - v1
+    branches: [v1]
+
+
+
   schedule:
     - cron: '0 6 * * 6'
 
@@ -34,7 +36,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - run: npm install --only=prod
-      - uses: oprypin/install-crystal@v1
+      - uses: crystal-lang/install-crystal@v1
         with: ${{ matrix.config }}
         id: install
       - run: |

.gitignore

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

.tools/upgrade.sh

@@ -7,6 +7,6 @@ cd "$(dirname "$0")/.."
 rm -f package-lock.json
 
 ncu -u
-npm install
+npm update
 npm test
 git commit -a -m "Upgrade packages"

README.md

@@ -5,18 +5,22 @@ install-crystal
 
 Works on Ubuntu, macOS, Windows.
 
+### Quickstart
+
+**[Configurator][]**: get a pre-made config for your exact use case!
+
 ## Examples
 
 ```yaml
 steps:
-  - uses: oprypin/install-crystal@v1
+  - uses: crystal-lang/install-crystal@v1
   - run: crystal eval "puts 1337"
 ```
 
 ```yaml
 steps:
   - uses: actions/checkout@v2
-  - uses: oprypin/install-crystal@v1
+  - uses: crystal-lang/install-crystal@v1
     with:
       crystal: 0.35.1
   - run: shards install
@@ -34,13 +38,13 @@ steps:
           - {os: windows-latest}
     runs-on: ${{matrix.os}}
     steps:
-      - uses: oprypin/install-crystal@v1
+      - uses: crystal-lang/install-crystal@v1
         with:
           crystal: ${{matrix.crystal}}
       - uses: actions/checkout@v2
       - run: shards install
       - run: crystal spec
-      - run: crystal tool format --check
+      - run: crystal tool format && git diff --exit-code
         if: matrix.crystal == 'latest'
 ```
 
@@ -52,68 +56,69 @@ Alternatively, you can use the container-based approach [as in the starter workf
 
 ### Inputs
 
-* * **`crystal: 0.35.1`** (not supported on Windows)
+ *   *  **`crystal: 0.35.1`** (not supported on Windows)
 
-    Install a particular release of Crystal.
+        Install a particular release of Crystal.
 
-  * **`crystal: latest`** (default; not supported on Windows)
+     *  **`crystal: latest`** (default; not supported on Windows)
 
-    Install the latest released version of Crystal.
+        Install the latest released version of Crystal.
 
-  * **`crystal: nightly`** (default on Windows)
+     *  **`crystal: nightly`** (default on Windows)
 
-    Install Crystal from the latest continuous build on [crystal.git][] master.
+        Install Crystal from the latest continuous build on [crystal.git][] master.
 
-* * **`shards: true`** (default)
+ *   *  **`shards: true`** (default)
 
-    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.
+        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.
 
-  * **`shards: false`**
+     *  **`shards: false`**
 
-    Ensure that `shards` executable is *not* available.
+        Ensure that `shards` executable is *not* available.
 
-  * **`shards: latest`**
+     *  **`shards: latest`**
 
-    Build and install the latest released version of Shards.
+        Build and install the latest released version of Shards.
 
-  * **`shards: 0.13.0`**
+     *  **`shards: 0.13.0`**
 
-    Build and install a particular release of Shards.
+        Build and install a particular release of Shards.
 
-  * **`shards: nightly`**
+     *  **`shards: nightly`**
 
-    Build and install the latest commit of [shards.git][] master.
+        Build and install the latest commit of [shards.git][] master.
 
-* **`arch: x86_64`**, **`arch: x86`** (defaults to current OS arch)
+ *  **`arch: x86_64`**, **`arch: x86`** (defaults to current OS arch)
 
-  The architecture of the build of Crystal to download.
+    The architecture of the build of Crystal to download.
 
-* **`destination: some/path`**
+ *  **`destination: some/path`**
 
-  The directory to store Crystal in, after extracting. Will directly affect `outputs.path` (the default is in a temporary location).
+    The directory to store Crystal in, after extracting. Will directly affect `outputs.path` (the default is in a temporary location).
 
-* **`token: ${{ github.token }}`**
+ *  **`token: ${{ github.token }}`**
 
-  Personal access token (auto-populated).
+    Personal access token (auto-populated).
 
 ### Outputs
 
-* **`crystal`** (`${{ steps.some_step_id.outputs.crystal }}`)
+ *  **`crystal`** (`${{ steps.some_step_id.outputs.crystal }}`)
 
-  The actual version of Crystal (as a ref in crystal-lang/[crystal.git][]) that was installed.
+    The actual version of Crystal (as a ref in crystal-lang/[crystal.git][]) that was installed.
 
-* **`shards`** (`${{ steps.some_step_id.outputs.shards }}`)
+ *  **`shards`** (`${{ steps.some_step_id.outputs.shards }}`)
 
-  The actual version of Shards (as a ref in crystal-lang/[shards.git][]) that was installed.
+    The actual version of Shards (as a ref in crystal-lang/[shards.git][]) that was installed.
 
-* **`path`** (`${{ steps.some_step_id.outputs.path }}`)
+ *  **`path`** (`${{ steps.some_step_id.outputs.path }}`)
 
-  The path where Crystal was extracted to, so you can use '[path]/bin/crystal', '[path]/src' etc.
+    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
+[configurator]: https://crystal-lang.github.io/install-crystal/configurator.html

docs/assets/script.js

@@ -0,0 +1 @@
+hljs.initHighlighting();

docs/assets/style.css

@@ -0,0 +1,44 @@
+.hljs-string, .hljs-literal, .hljs-number {
+    color: var(--md-code-hl-string-color);
+}
+.hljs-comment {
+    color: var(--md-code-hl-comment-color);
+}
+.hljs-bullet {
+    margin-top: 0.4em !important;
+    display: inline-block;
+}
+.hljs-attr + .hljs-bullet {
+    display: inline;
+}
+pre {
+    line-height: 1.5 !important;
+}
+
+.configurator {
+    line-height: 2;
+}
+.configurator hr {
+    margin: 0.5em 0 !important;
+}
+
+h1 {
+    color: var(--md-default-fg-color) !important;
+}
+.configurator input {
+    vertical-align: text-top;
+}
+input + label {
+    cursor: pointer;
+}
+
+.configurator input:not(:checked) + label {
+    opacity: 0.85;
+}
+.configurator label {
+    text-decoration: underline;
+    text-decoration-color: var(--md-default-fg-color--light);
+}
+.configurator input:not(:checked) + label {
+    text-decoration: none;
+}