Merge pull request #842 from ocaml/set-git-to-ignore-cygwin-local-package-directory

Set Git to ignore Cygwin local package directory

Author: smorimoto

CHANGELOG.md

@@ -8,6 +8,10 @@ and this project adheres to
 
 ## [unreleased]
 
+### Changed
+
+- Set Git to ignore Cygwin local package directory.
+
 ## [3.0.4]
 
 ### Changed

dist/index.js

@@ -1,6 +1,5 @@
 import * as crypto from "node:crypto";
 import * as path from "node:path";
-import * as process from "node:process";
 import * as cache from "@actions/cache";
 import * as core from "@actions/core";
 import { exec } from "@actions/exec";
@@ -9,9 +8,10 @@ import * as system from "systeminformation";
 import {
   ARCHITECTURE,
   CACHE_PREFIX,
-  CYGWIN_MIRROR,
+  CYGWIN_LOCAL_PACKAGE_DIRECTORY,
   CYGWIN_ROOT,
   DUNE_CACHE_ROOT,
+  GITHUB_WORKSPACE,
   OPAM_DISABLE_SANDBOXING,
   OPAM_REPOSITORIES,
   OPAM_ROOT,
@@ -64,14 +64,12 @@ async function composeOpamCacheKeys() {
 }
 
 function composeCygwinCachePaths() {
-  const paths = [];
-  const githubWorkspace = process.env.GITHUB_WORKSPACE ?? process.cwd();
-  paths.push(CYGWIN_ROOT);
   const cygwinRootSymlinkPath = path.posix.join("/cygdrive", "d", "cygwin");
-  paths.push(cygwinRootSymlinkPath);
-  const cygwinEncodedUri = encodeURIComponent(CYGWIN_MIRROR).toLowerCase();
-  const cygwinPackageRoot = path.join(githubWorkspace, cygwinEncodedUri);
-  paths.push(cygwinPackageRoot);
+  const paths = [
+    CYGWIN_LOCAL_PACKAGE_DIRECTORY,
+    CYGWIN_ROOT,
+    cygwinRootSymlinkPath,
+  ];
   return paths;
 }
 
@@ -81,7 +79,8 @@ function composeDuneCachePaths() {
 }
 
 function composeOpamCachePaths() {
-  const paths = [OPAM_ROOT];
+  const opamLocalCachePath = path.join(GITHUB_WORKSPACE, "_opam");
+  const paths = [OPAM_ROOT, opamLocalCachePath];
   if (PLATFORM === "windows") {
     const {
       repo: { repo },
@@ -96,9 +95,6 @@ function composeOpamCachePaths() {
     );
     paths.push(opamCygwinLocalCachePath);
   }
-  const githubWorkspace = process.env.GITHUB_WORKSPACE ?? process.cwd();
-  const opamLocalCachePath = path.join(githubWorkspace, "_opam");
-  paths.push(opamLocalCachePath);
   return paths;
 }
 

dist/post/index.js

@@ -50,6 +50,14 @@ export const PLATFORM = (() => {
 
 export const CYGWIN_MIRROR = "https://cygwin.mirror.constant.com/";
 
+export const GITHUB_WORKSPACE = process.env.GITHUB_WORKSPACE ?? process.cwd();
+
+export const CYGWIN_LOCAL_PACKAGE_DIRECTORY = (() => {
+  const cygwinMirrorEncodedUri =
+    encodeURIComponent(CYGWIN_MIRROR).toLowerCase();
+  return path.join(GITHUB_WORKSPACE, cygwinMirrorEncodedUri);
+})();
+
 // [HACK] https://github.com/ocaml/setup-ocaml/pull/55
 export const CYGWIN_ROOT = path.join("D:", "cygwin");
 

packages/setup-ocaml/src/cache.ts

@@ -1,11 +1,18 @@
+import * as fs from "node:fs/promises";
+import * as os from "node:os";
+import * as path from "node:path";
 import * as core from "@actions/core";
 import { exec } from "@actions/exec";
 import { HttpClient } from "@actions/http-client";
 import * as io from "@actions/io";
 import * as toolCache from "@actions/tool-cache";
 import * as cheerio from "cheerio";
 import * as semver from "semver";
-import { CYGWIN_MIRROR, CYGWIN_ROOT } from "./constants.js";
+import {
+  CYGWIN_LOCAL_PACKAGE_DIRECTORY,
+  CYGWIN_MIRROR,
+  CYGWIN_ROOT,
+} from "./constants.js";
 
 function createHttpClient() {
   return new HttpClient(
@@ -30,8 +37,27 @@ export async function getCygwinVersion() {
   return version;
 }
 
+async function setGitToIgnoreCygwinLocalPackageDirectory() {
+  const xdgConfigHome = process.env.XDG_CONFIG_HOME;
+  const homeDir = os.homedir();
+  const globalGitConfigDir = xdgConfigHome
+    ? path.join(xdgConfigHome, "git")
+    : path.join(homeDir, ".config", "git");
+  await fs.mkdir(globalGitConfigDir, { recursive: true });
+  const globalGitIgnorePath = path.join(globalGitConfigDir, "ignore");
+  await fs.appendFile(globalGitIgnorePath, CYGWIN_LOCAL_PACKAGE_DIRECTORY, {
+    encoding: "utf8",
+  });
+  await exec(
+    "git",
+    ["config", "--add", "--global", "core.excludesfile", globalGitIgnorePath],
+    { windowsVerbatimArguments: true },
+  );
+}
+
 export async function setupCygwin() {
   await core.group("Prepare the Cygwin environment", async () => {
+    await setGitToIgnoreCygwinLocalPackageDirectory();
     const version = await getCygwinVersion();
     const cachedPath = toolCache.find("cygwin", version, "x86_64");
     if (cachedPath === "") {