Merge branch 'master' into v1

Author: oprypin

.github/workflows/deploy-docs.yml

@@ -14,18 +14,17 @@ jobs:
       - name: Download source
         uses: actions/checkout@v4
       - name: Install Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.11'
       - name: Install dependencies
-        run: pip install --no-deps -r docs/requirements.txt
+        run: pip install --no-deps -r requirements/requirements-docs.txt
       - name: Fetch branch
         run: git fetch origin v1:v1
       - name: Build site
-        run: mkdocs build
-        working-directory: docs
+        run: mkdocs build -f docs/mkdocs.yml --strict
       - name: Upload to GitHub Pages
-        uses: actions/upload-pages-artifact@v2
+        uses: actions/upload-pages-artifact@v3
         with:
           path: site
   deploy:
@@ -38,7 +37,7 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}

.github/workflows/main.yml

@@ -27,14 +27,16 @@ jobs:
         exclude:
           - os: windows-latest
             config: {shards: '0.12.0', crystal: '0.35.1'}
+          - os: macos-latest
+            config: {shards: '0.12.0', crystal: '0.35.1'}
 
     name: crystal ${{ matrix.config.crystal }} + shards ${{ matrix.config.shards }} (${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     defaults:
       run:
         shell: bash
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: npm install --only=prod
       - uses: ./
         with: ${{ matrix.config }}

.github/workflows/release.yml

@@ -27,6 +27,8 @@ jobs:
         exclude:
           - os: windows-latest
             config: {shards: '0.12.0', crystal: '0.35.1'}
+          - os: macos-latest
+            config: {shards: '0.12.0', crystal: '0.35.1'}
 
     name: crystal ${{ matrix.config.crystal }} + shards ${{ matrix.config.shards }} (${{ matrix.os }})
     runs-on: ${{ matrix.os }}

README.md

@@ -19,10 +19,10 @@ steps:
 
 ```yaml
 steps:
-  - uses: actions/checkout@v3
+  - uses: actions/checkout@v4
   - uses: crystal-lang/install-crystal@v1
     with:
-      crystal: 1.2
+      crystal: 1.11
   - run: shards install
   - run: crystal spec
 ```
@@ -41,7 +41,7 @@ steps:
       - uses: crystal-lang/install-crystal@v1
         with:
           crystal: ${{matrix.crystal}}
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: shards install
       - run: crystal spec
       - run: crystal tool format && git diff --exit-code

docs/configurator.md

@@ -85,7 +85,7 @@ jobs:
     {%- endif %}
     steps:
       - name: Download source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Crystal
         uses: crystal-lang/install-crystal@v1
         {%- if crystal_nightly or crystal_ver %}
@@ -94,7 +94,7 @@ jobs:
         {%- endif %}
       {%- if cache_shards %}
       - name: Cache shards
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           {%- if is_app %}
           path: lib
@@ -159,10 +159,10 @@ var fixedRef = document.getElementById('fixed-ref');
 
 function fixedRefChange() {
     var codes = document.querySelectorAll('.configurator .hljs-string');
-    var rev = fixedRef.checked ? '{{ latest_rev }}' : 'v1';
+    var rev = fixedRef.checked ? '{{ latest_rev }} # {{ latest_tag }}' : 'v1';
     for (var i = 0; i < codes.length; ++i) {
         if (codes[i].innerHTML.includes('install-crystal')) {
-            codes[i].innerHTML = codes[i].innerHTML.replace(/@\w+/g, '@' + rev);
+            codes[i].innerHTML = codes[i].innerHTML.replace(/@\w+.*/g, '@' + rev);
         }
     }
 }

docs/gen_pages.py

@@ -1,4 +1,8 @@
+import subprocess
+
 import mkdocs_gen_files
+import jinja2
+
 
 with mkdocs_gen_files.open("assets/style.css", "a") as f:
     f.write(
@@ -10,3 +14,12 @@
         )
         + " {\n    display: none;\n}\n"
     )
+
+with mkdocs_gen_files.open("configurator.md", "r") as f:
+    content = f.read()
+content = jinja2.Template(content).render(
+    latest_rev=subprocess.check_output("git rev-parse v1".split(), encoding="utf-8").strip(),
+    latest_tag=subprocess.check_output("git describe --exact-match v1".split(), encoding="utf-8").strip(),
+)
+with mkdocs_gen_files.open("configurator.md", "w") as f:
+    f.write(content)

docs/main.py

@@ -14,6 +14,8 @@ theme:
     scheme: preference
     primary: black
     accent: purple
+  features:
+    - content.action.edit
 
 extra_css:
   - assets/style.css
@@ -23,7 +25,6 @@ extra_javascript:
 
 plugins:
   - search
-  - macros
   - same-dir
   - gen-files:
       scripts:
@@ -37,6 +38,9 @@ markdown_extensions:
   - pymdownx.details
   - pymdownx.snippets:
       check_paths: true
+      restrict_base_path: false
+      base_path:
+        - !relative $docs_dir
   - admonition
   - def_list
   - toc: