save

Author: jcbhmr

.github/workflows/npm-publish.yml

@@ -7,6 +7,9 @@ concurrency: ${{ github.workflow }}
 jobs:
   npm-publish:
     runs-on: windows-latest
+    defaults:
+      run:
+        shell: bash
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4

.github/workflows/npm-test.yml

@@ -15,8 +15,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: ["18", "20"]
+        node-version: ["18", "20", "22"]
     runs-on: windows-latest
+    defaults:
+      run:
+        shell: bash
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4

LICENSE

@@ -1,12 +1,33 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 2, June 1991
+
+ Note that the only valid version of the GPL as far as this project
+ is concerned is _this_ particular version of the license (ie v2, not
+ v2.2 or v3.x or whatever), unless explicitly otherwise stated.
+
+ HOWEVER, in order to allow a migration to GPLv3 if that seems like
+ a good idea, I also ask that people involved with the project make
+ their preferences known. In particular, if you trust me to make that
+ decision, you might note so in your copyright message, ie something
+ like
+
+	This file is licensed under the GPL v2, or a later version
+	at the discretion of Linus.
+
+  might avoid issues. But we can also just decide to synchronize and
+  contact all copyright holders on record if/when the occasion arises.
+
+			Linus Torvalds
+
+----------------------------------------
+
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
 
  Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
-                            Preamble
+			    Preamble
 
   The licenses for most software are designed to take away your
 freedom to share and change it.  By contrast, the GNU General Public
@@ -56,7 +77,7 @@ patent must be licensed for everyone's free use or not licensed at all.
   The precise terms and conditions for copying, distribution and
 modification follow.
 
-                    GNU GENERAL PUBLIC LICENSE
+		    GNU GENERAL PUBLIC LICENSE
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
   0. This License applies to any program or other work which contains
@@ -255,7 +276,7 @@ make exceptions for this.  Our decision will be guided by the two goals
 of preserving the free status of all derivatives of our free software and
 of promoting the sharing and reuse of software generally.
 
-                            NO WARRANTY
+			    NO WARRANTY
 
   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
@@ -277,9 +298,9 @@ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.
 
-                     END OF TERMS AND CONDITIONS
+		     END OF TERMS AND CONDITIONS
 
-            How to Apply These Terms to Your New Programs
+	    How to Apply These Terms to Your New Programs
 
   If you develop a new program, and you want it to be of the greatest
 possible use to the public, the best way to achieve this is to make it

PortableGit-64-bit.7z.exe

@@ -35,6 +35,8 @@ You can install this package using npm or your favorite npm package manager. If
 npm install --save-dev portablegit
 ```
 
+<sup>This package has a `postinstall` script</sup>
+
 ⚠️ **It's not recommended to install this package globally!** [Install Git for Windows normally](https://gitforwindows.org/) on your system instead. Interested in installing Git globally on more that just Windows machines? Check out [Git - Installing Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
 
 🛑 Only works on Windows x64 systems. Does not work on macOS or Linux.
@@ -62,24 +64,29 @@ Available binary commands exposed through this npm package are:
 - **`git-cmd`:** Starts a `cmd.exe` subshell preloaded with `git.exe` and other things in `$PATH`. Does **not** launch a new window.
 - **`git-gui`:** Starts [the Git GUI](https://git-scm.com/docs/git-gui).
 - **`gitk`:** Starts [the GitK GUI](https://git-scm.com/docs/gitk/).
+- `tig`, `start-ssh-agent`, `start-ssh-pagent`, `scalar`, `git-receive-pack` `git-upload-pack`: Extra things that I'm not not smart enough to understand.
+
+This `portablegit` npm package is versioned to follow Git for Windows. For example, Git for Windows releases `v2.45.1.windows.1` (derived from Git 2.45.1) which this `portablegit` package releases as `2.45.11`. Note that there's a `1` suffix appended to the version number. Git for Windows `v2.45.1.windows.2` would then be released as `[email protected]` on npm. For `X.Y.0.windows.1` releases the npm-ified `X.Y.01` version specifier is invalid. We need to drop the leading zero to create an `X.Y.1` release.
 
 You can `import.meta.resolve()` or `require.resolve()` anything that would normally be in the extracted `PortableGit/*` folder. Here's an example:
 
 ```js
-const cat = import.meta.resolve("portablegit/usr/bin/cat.exe");
+const cat = import.meta.resolve("portablegit/usr/bin/cat");
 console.log(cat);
-//=> 'file:///C:/Users/you/Documents/myproject/node_modules/portablegit/out/portablegit/usr/bin/cat.exe'
+//=> 'file:///C:/myproject/node_modules/portablegit/out/portablegit/usr/bin/cat'
 
-const cut = require.resolve("portablegit/usr/bin/cut.exe");
+const cut = require.resolve("portablegit/usr/bin/cut");
 console.log(cut);
-//=> 'C:\\Users\\you\\Documents\\myproject\\node_modules\\portablegit\\out\\portablegit\\usr\\bin\\cut.exe'
+//=> 'C:\\myproject\\node_modules\\portablegit\\out\\portablegit\\usr\\bin\\cut'
 ```
 
-This can be useful if you need to resolve the path to a specific binary (`cat.exe`, `cut.exe`, etc.) that isn't exposed by default.
+This can be useful if you need to resolve the path to a specific binary (`cat.exe`, `cut.exe`, etc.) that isn't exposed by default. Note that you don't need to use the `.exe` suffix since Windows will helpfully add `.exe` when attempting to run the file.
 
 ## Development
 
 ![Node.js](https://img.shields.io/static/v1?style=for-the-badge&message=Node.js&color=339933&logo=Node.js&logoColor=FFFFFF&label=)
 ![GitHub Actions](https://img.shields.io/static/v1?style=for-the-badge&message=GitHub+Actions&color=2088FF&logo=GitHub+Actions&logoColor=FFFFFF&label=)
 
-You'll need a Windows computer to test this package locally. You can run `npm run build` to make sure everything looks good locally. `npm run generate` will check for a new Git for Windows PortableGit release and download it if it exists. Make sure you do this manually on each new Git for Windows release. You can subscribe to releases on the [git-for-windows/git](https://github.com/git-for-windows/git) repository.
+You'll need a Windows computer to test this package locally. You can run `npm run build` to make sure everything looks good locally. `npm run generate` redownloads the configured version of Git for Windows PortableGit as a 7zip self-extracting archive.
+
+Each new upcoming release will first be tried as a prerelease `-rc.N` first to make sure that everything is 99% guarenteed to work when autopublishing.

README.md

@@ -0,0 +1,28 @@
+import test from "node:test";
+import assert from "node:assert/strict";
+import { $ } from "execa";
+import { readFile } from "node:fs/promises";
+const package_ = JSON.parse(
+  await readFile(new URL(import.meta.resolve("./package.json")), "utf8"),
+);
+
+await $({ stdio: "inherit" })`npm run build`;
+// simulate postinstall
+await $({
+  cwd: "out",
+  stdio: "inherit",
+  reject: false,
+})`post-install.bat`;
+
+test("git", async () => {
+  await $({ stdio: "inherit" })`${package_.bin.git} --version`;
+});
+
+test("bash", async () => {
+  await $({ stdio: "inherit" })`${package_.bin.bash} --version`;
+});
+
+test("import.meta.resolve()", () => {
+    console.log(import.meta.resolve("portablegit/usr/bin/cat"))
+    console.log(import.meta.resolve("portablegit/usr/bin/cat.exe"))
+})