Merge branch 'master' into v1

Author: oprypin

.github/test/crystal-libs_spec.cr

@@ -0,0 +1,45 @@
+require "spec"
+require "yaml"
+
+it "yaml" do
+  any = YAML::Any.new({
+    YAML::Any.new("foo") => YAML::Any.new(12_i64)
+  })
+  YAML.parse(any.to_yaml).should eq any
+end
+
+require "xml"
+
+it "xml" do
+  string = XML.build do |xml|
+    xml.element("person", id: 1) do
+      xml.element("firstname") { xml.text "Jane" }
+      xml.element("lastname") { xml.text "Doe" }
+    end
+  end
+
+  document = XML.parse(string)
+  person = document.first_element_child.should_not be_nil
+  person["id"].should eq "1"
+
+  props = {} of String => String
+  person.children.select(&.element?).each do |child|
+    props[child.name] = child.content
+  end
+  props.should eq({
+    "firstname" => "Jane",
+    "lastname" => "Doe",
+  })
+end
+
+require "big"
+
+it "big" do
+  1.to_big_d.to_i.should eq 1
+end
+
+require "openssl/sha1"
+
+it "openssl" do
+  OpenSSL::SHA1.hash("foobarbaz").should eq StaticArray[95, 85, 19, 248, 130, 47, 219, 229, 20, 90, 243, 59, 100, 216, 217, 112, 220, 249, 92, 110]
+end

.github/workflows/deploy-docs.yml

@@ -9,11 +9,10 @@ on:
     - cron: '0 6 * * 6'
 jobs:
   build:
-    name: Deploy docs
     runs-on: ubuntu-latest
     steps:
       - name: Download source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Python
         uses: actions/setup-python@v4
         with:
@@ -25,9 +24,21 @@ jobs:
       - 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
+      - name: Upload to GitHub Pages
+        uses: actions/upload-pages-artifact@v2
         with:
-          publish_dir: site
-          commit_message: 'Generate docs: '
+          path: site
+  deploy:
+    if: github.event_name == 'push' && github.ref_name == github.event.repository.default_branch
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}

.github/workflows/main.yml

@@ -23,6 +23,7 @@ jobs:
           - {shards: '0.14', crystal: '1.3'}
           - {shards: latest, crystal: latest}
           - {shards: nightly, crystal: nightly}
+          - {crystal: 'branch:master'}
         exclude:
           - os: windows-latest
             config: {shards: '0.12.0', crystal: '0.35.1'}
@@ -55,10 +56,9 @@ jobs:
       - run: |
           v='${{ matrix.config.crystal }}'
           crystal --version | grep -E "${v}\\b"
-        if: ${{ contains(matrix.config.crystal, '.') }}
+        if: ${{ contains(matrix.config.crystal, '.') && !contains(matrix.config.crystal, 'branch:') }}
       - run: |
-          crystal eval 'require "yaml"; require "xml"; require "big"; require "openssl"'
-
+          crystal spec .github/test/crystal-libs_spec.cr
       - run: |
           shards --version
         if: ${{ !contains('false', matrix.config.shards) }}
@@ -82,7 +82,6 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: npm install
       - run: npm test
-      - run: npm audit --audit-level=moderate --only=prod

.github/workflows/release.yml

@@ -23,6 +23,7 @@ jobs:
           - {shards: '0.14', crystal: '1.3'}
           - {shards: latest, crystal: latest}
           - {shards: nightly, crystal: nightly}
+          - {crystal: 'branch:master'}
         exclude:
           - os: windows-latest
             config: {shards: '0.12.0', crystal: '0.35.1'}
@@ -33,7 +34,7 @@ jobs:
       run:
         shell: bash
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: crystal-lang/install-crystal@v1
         with: ${{ matrix.config }}
@@ -55,10 +56,9 @@ jobs:
       - run: |
           v='${{ matrix.config.crystal }}'
           crystal --version | grep -E "${v}\\b"
-        if: ${{ contains(matrix.config.crystal, '.') }}
+        if: ${{ contains(matrix.config.crystal, '.') && !contains(matrix.config.crystal, 'branch:') }}
       - run: |
-          crystal eval 'require "yaml"; require "xml"; require "big"; require "openssl"'
-
+          crystal spec .github/test/crystal-libs_spec.cr
       - run: |
           shards --version
         if: ${{ !contains('false', matrix.config.shards) }}

README.md

@@ -68,6 +68,10 @@ Alternatively, you can use the container-based approach [as in the starter workf
 
         Install Crystal from the latest continuous build on [crystal.git][] master.
 
+     *  **`crystal: "branch:foo/bar"`**
+
+        Install Crystal from the latest maintenance build on [crystal.git][] branch specified after `branch:`.
+
  *   *  **`shards: true`** (default)
 
         Ensure that *some* released version of [Shards][] is available.

action.yml

@@ -22,7 +22,7 @@ outputs:
   path:
     description: The directory where Crystal was installed
 runs:
-  using: node16
+  using: node20
   main: index.js
 branding:
   icon: octagon

docs/requirements.txt

@@ -39,17 +39,17 @@ mkdocs-gen-files==0.4.0
     # via -r requirements.in
 mkdocs-macros-plugin==0.7.0
     # via -r requirements.in
-mkdocs-material==8.5.10
+mkdocs-material==8.5.11
     # via -r requirements.in
-mkdocs-material-extensions==1.1
+mkdocs-material-extensions==1.1.1
     # via mkdocs-material
 mkdocs-same-dir==0.1.2
     # via -r requirements.in
 packaging==21.3
     # via mkdocs
 pygments==2.13.0
     # via mkdocs-material
-pymdown-extensions==9.8
+pymdown-extensions==9.9
     # via
     #   -r requirements.in
     #   mkdocs-material
@@ -70,9 +70,9 @@ requests==2.28.1
     # via mkdocs-material
 six==1.16.0
     # via python-dateutil
-termcolor==2.1.0
+termcolor==2.1.1
     # via mkdocs-macros-plugin
-urllib3==1.26.12
+urllib3==1.26.13
     # via requests
 watchdog==2.1.9
     # via mkdocs

index.js

@@ -33,7 +33,7 @@ async function run() {
             params.shards = "nightly";
         }
         params.path = Core.getInput("destination") || Path.join(
-            process.env["RUNNER_TEMP"], `crystal-${params.crystal}-${params.shards}-${params.arch}`,
+            process.env["RUNNER_TEMP"], `crystal-${params.crystal.replace("branch:", "")}-${params.shards}-${params.arch}`,
         );
         Core.setOutput("path", params.path);
 
@@ -87,17 +87,22 @@ const Nightly = "nightly";
 const Any = "true";
 const None = "false";
 const NumericVersion = /^\d([.\d]*\d)?$/;
+const BranchVersion = /^branch:(.+)$/;
 
 function checkVersion(version, allowed, earliestAllowed = null) {
     const numericVersion = NumericVersion.test(version) && version;
     if (numericVersion && (!earliestAllowed || cmpTags(numericVersion, earliestAllowed) >= 0)) {
         allowed[allowed.indexOf(NumericVersion)] = numericVersion;
     }
+    const branchVersion = BranchVersion.test(version) && version;
+    if (branchVersion) {
+        allowed[allowed.indexOf(BranchVersion)] = branchVersion;
+    }
 
     if (allowed.includes(version)) {
         return version;
     }
-    if ([Latest, Nightly, numericVersion].includes(version)) {
+    if ([Latest, Nightly, numericVersion, branchVersion].includes(version)) {
         throw `Version "${version}" is not supported on ${getPlatform()}`;
     }
     throw `Version "${version}" is invalid`;
@@ -116,7 +121,7 @@ async function subprocess(command, options) {
 }
 
 async function installCrystalForLinux({crystal, shards, arch = getArch(), path}) {
-    checkVersion(crystal, [Latest, Nightly, NumericVersion]);
+    checkVersion(crystal, [Latest, Nightly, NumericVersion, BranchVersion]);
     const filePatterns = {"x86_64": /-linux-x86_64\.tar\.gz$/, "x86": /-linux-i686\.tar\.gz$/};
     checkArch(arch, Object.keys(filePatterns));
 
@@ -141,7 +146,7 @@ async function installCrystalForLinux({crystal, shards, arch = getArch(), path})
 }
 
 async function installCrystalForMac({crystal, shards, arch = "x86_64", path}) {
-    checkVersion(crystal, [Latest, Nightly, NumericVersion]);
+    checkVersion(crystal, [Latest, Nightly, NumericVersion, BranchVersion]);
     if (crystal === Latest || crystal === Nightly || cmpTags(crystal, "1.2") >= 0) {
         checkArch(arch, ["universal", "x86_64", "aarch64"]);
     } else {
@@ -186,12 +191,17 @@ async function installAptPackages(packages) {
 
 async function installBinaryRelease({crystal, filePattern, path}) {
     if (crystal === Nightly) {
-        await IO.mv(await downloadCrystalNightly(filePattern), path);
+        await IO.mv(await downloadCrystalNightly(filePattern, "master"), path);
     } else {
-        if (crystal === Latest) {
-            crystal = null;
+        const version = BranchVersion.exec(crystal);
+        if (version) {
+            await IO.mv(await downloadCrystalNightly(filePattern, version[1]), path);
+        } else {
+            if (crystal === Latest) {
+                crystal = null;
+            }
+            await IO.mv(await downloadCrystalRelease(filePattern, crystal), path);
         }
-        await IO.mv(await downloadCrystalRelease(filePattern, crystal), path);
     }
 }
 
@@ -336,7 +346,7 @@ async function downloadCrystalRelease(filePattern, version = null) {
     const resp = await github.request({
         url: asset["url"],
         headers: {"accept": "application/octet-stream"},
-        request: {redirect: "manual"},
+        request: {fetch: fetchWithManualRedirect},
     });
     const url = resp.headers["location"];
 
@@ -365,29 +375,29 @@ async function downloadSource({name, repo, ref}) {
 
     const resp = await github.rest.repos.downloadZipballArchive({
         ...repo, ref,
-        request: {redirect: "manual"},
+        request: {fetch: fetchWithManualRedirect},
     });
     const url = resp.headers["location"];
     const downloadedPath = await ToolCache.downloadTool(url);
     Core.info(`Extracting ${name} source`);
     return onlySubdir(await ToolCache.extractZip(downloadedPath));
 }
 
-async function downloadCrystalNightly(filePattern) {
-    Core.info("Looking for latest Crystal build");
+async function downloadCrystalNightly(filePattern, branch) {
+    Core.info(`Looking for latest Crystal build of branch '${branch}'`);
 
     let build;
     for (let offset = 0; ;) {
-        const req = `/tree/master?filter=successful&shallow=true&limit=100&offset=${offset}`;
+        const req = `/tree/${branch}?filter=successful&shallow=true&limit=100&offset=${offset}`;
         const resp = await fetch(CircleApiBase + req);
         const builds = await resp.json();
         build = builds.find((b) => b["workflows"]["job_name"] === "dist_artifacts");
         if (build) {
             break;
         }
         offset += builds.length;
-        if (offset >= 1000) {
-            throw "Could not find a matching nightly build";
+        if (offset >= 1000 || builds.length === 0) {
+            throw `Could not find a matching build for branch '${branch}'`;
         }
     }
     Core.info(`Found Crystal build ${build["build_url"]}`);
@@ -397,6 +407,9 @@ async function downloadCrystalNightly(filePattern) {
     const resp = await fetch(CircleApiBase + req);
     const artifacts = await resp.json();
     const artifact = artifacts.find((a) => filePattern.test(a["path"]));
+    if (artifact === undefined) {
+        throw `Could not find build artifacts for build ${build["build_num"]}`;
+    }
 
     Core.info(`Downloading Crystal build from ${artifact["url"]}`);
     const downloadedPath = await ToolCache.downloadTool(artifact["url"]);
@@ -406,14 +419,19 @@ async function downloadCrystalNightly(filePattern) {
 }
 
 async function installCrystalForWindows({crystal, shards, arch = "x86_64", path}) {
-    checkVersion(crystal, [Latest, Nightly, NumericVersion], "1.3");
+    checkVersion(crystal, [Latest, Nightly, NumericVersion, BranchVersion], "1.3");
     checkArch(arch, ["x86_64"]);
 
     if (crystal === Nightly) {
-        await IO.mv(await downloadCrystalNightlyForWindows(), path);
+        await IO.mv(await downloadCrystalNightlyForWindows("master"), path);
     } else {
-        const filePattern = /-windows-x86_64-msvc(-unsupported)?\.zip$/;
-        await installBinaryRelease({crystal, shards, filePattern, path});
+        const version = BranchVersion.exec(crystal);
+        if (version) {
+            await IO.mv(await downloadCrystalNightlyForWindows(version[1]), path);
+        } else {
+            const filePattern = /-windows-x86_64-msvc(-unsupported)?\.zip$/;
+            await installBinaryRelease({crystal, shards, filePattern, path});
+        }
     }
 
     Core.info("Setting up environment for Crystal");
@@ -425,11 +443,11 @@ async function installCrystalForWindows({crystal, shards, arch = "x86_64", path}
     }
 }
 
-async function downloadCrystalNightlyForWindows() {
-    Core.info("Looking for latest Crystal build");
+async function downloadCrystalNightlyForWindows(branch) {
+    Core.info(`Looking for latest Crystal build of branch '${branch}'`);
 
     const runsResp = await github.rest.actions.listWorkflowRuns({
-        ...RepoCrystal, "workflow_id": "win.yml", "branch": "master",
+        ...RepoCrystal, "workflow_id": "win.yml", "branch": branch,
         "event": "push", "status": "success", "per_page": 1,
     });
     const [workflowRun] = runsResp.data["workflow_runs"];
@@ -445,7 +463,7 @@ async function downloadCrystalNightlyForWindows() {
     Core.info("Downloading Crystal build");
     const resp = await github.rest.actions.downloadArtifact({
         ...RepoCrystal, "artifact_id": artifact.id, "archive_format": "zip",
-        request: {redirect: "manual"},
+        request: {fetch: fetchWithManualRedirect},
     });
     const url = resp.headers["location"];
     const downloadedPath = await ToolCache.downloadTool(url);
@@ -456,6 +474,10 @@ async function downloadCrystalNightlyForWindows() {
 
 const github = new Octokit({auth: Core.getInput("token") || null});
 
+function fetchWithManualRedirect(url, options) {
+    return fetch(url, {...options, redirect: "manual"});
+}
+
 async function* getItemsFromPages(pages) {
     for await (const page of github.paginate.iterator(pages)) {
         for (const item of page.data) {