Merge remote-tracking branch 'origin/main' into rm-import-eq

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: CI
 on: [push, pull_request]
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
@@ -29,3 +29,42 @@ jobs:
       with:
         node-version: 12.x
     - run: npm test --ignore-scripts
+  create_tgz:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup node 20
+        uses: actions/setup-node@v2
+        with:
+          node-version: 20.x
+      - run: npm install
+      - run: npm run build
+      - run: npm pack
+      - run: mv $(ls | grep .tgz) umzug.tgz
+      - uses: actions/upload-artifact@v3
+        with:
+          name: tarball
+          path: umzug.tgz
+  test_tgz:
+    runs-on: ubuntu-latest
+    needs: [create_tgz]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
+        with:
+          name: tarball
+      - run: ls
+      - name: install tarball in examples directory
+        working-directory: examples/0.vanilla
+        run: |
+          rm -rf ../node_modules
+          npm init -y
+          npm install ../../umzug.tgz
+      - name: run example
+        run: |
+          cd examples/0.vanilla
+          node migrate up
+          node migrate down
+          node migrate create --name new-migration.js
+          node migrate up
+      - run: ls -R

examples/0.vanilla/ignoreme/uzmug.json

@@ -0,0 +1 @@
+[]

examples/0.vanilla/migrate.js

@@ -0,0 +1,14 @@
+const { Umzug, JSONStorage } = require('umzug');
+
+exports.migrator = new Umzug({
+	migrations: {
+		glob: 'migrations/*.js',
+	},
+	context: { directory: __dirname + '/ignoreme' },
+	storage: new JSONStorage({ path: 'ignoreme/uzmug.json' }),
+	logger: console,
+});
+
+if (require.main === module) {
+	exports.migrator.runAsCLI();
+}

examples/0.vanilla/migrations/2023.11.03T16.52.04.users-table.js

@@ -0,0 +1,12 @@
+const { promises: fs } = require('fs');
+
+/** @type {typeof import('../migrate').migrator['_types']['migration']} */
+exports.up = async ({ context }) => {
+	await fs.mkdir(context.directory, { recursive: true });
+	await fs.writeFile(context.directory + '/users.json', JSON.stringify([], null, 2));
+};
+
+/** @type {typeof import('../migrate').migrator['_types']['migration']} */
+exports.down = async ({ context }) => {
+	await fs.unlink(context.directory + '/users.json');
+};

examples/0.vanilla/readme.md

@@ -0,0 +1,16 @@
+This example shows the simplest possible, node-only setup for Umzug. No typescript, no database, no dependencies.
+
+Note:
+- The `context` for the migrations just contains a (gitignored) directory.
+- The example migration just writes an empty file to the directory
+
+```bash
+node migrate --help # show CLI help
+
+node migrate up # apply migrations
+node migrate down # revert the last migration
+node migrate create --name new-migration.js # create a new migration file
+
+node migrate up # apply migrations again
+node migrate down --to 0 # revert all migrations
+```