oneclickpush 0.1.0 → 0.2.0

package/README.md

@@ -9,7 +9,7 @@ in one command.
 [complicated](https://github.com/tschaub/gh-pages/tree/main/lib),
 [buggy](https://github.com/tschaub/gh-pages/issues), and
 [unmaintained](https://github.com/tschaub/gh-pages/issues/657#issue-4979248775); `oneclickpush` is
-none of these, has zero dependencies and only uses Node native functions + `git`.
+none of these, has zero dependencies and only uses built-in Node APIs + `git`.
 
 ## Quick Start
 
@@ -32,7 +32,9 @@ Options:
   -e, --exclude <glob>    Paths to leave out, relative to dist (default: "**/.DS_Store")
   -b, --branch <name>     Target branch (default: "gh-pages")
   -m, --message <msg>     Commit message (default: "Updates")
-  -f, --force             Force push with no history
+  -r, --remote <name|url> Remote name or repo URL to publish to (default: "origin")
+  -a, --author <author>   Commit author, as "Name <email>"
+  -f, --force             Force push new commit with no history
   -n, --dry-run           Show what would change, without committing or pushing
   -v, --verbose           Log git commands
   -V, --version           Print version
@@ -55,6 +57,13 @@ npx oneclickpush -d public -b release -m "deploy: v1.0.0"
 # Exclude source maps and test files
 npx oneclickpush -d dist -e "**/*.map" -e "**/tests/**"
 
+# Deploy to a different remote or repository URL
+npx oneclickpush -d dist -r upstream
+npx oneclickpush -d dist -r git@github.com:user/repo.git
+
+# Set commit author (useful in CI environments)
+npx oneclickpush -d dist -a "Deploy Bot <bot@example.com>"
+
 # Force push fresh history
 npx oneclickpush -d dist --force
 ```
@@ -76,6 +85,8 @@ const changes = await publish({
   exclude: ['**/.DS_Store', '**/*.map'],
   branch: 'gh-pages',
   message: 'Deploy updates',
+  remote: 'origin',
+  author: 'Deploy Bot <bot@example.com>',
   force: false,
   dryRun: false,
   verbose: false
@@ -96,19 +107,22 @@ if (changes) {
 | `exclude` | `string[]` | `["**/.DS_Store"]` | Paths to exclude relative to `dist`                 |
 | `branch`  | `string`   | `"gh-pages"`       | Target git branch                                   |
 | `message` | `string`   | `"Updates"`        | Git commit message                                  |
+| `remote`  | `string`   | `"origin"`         | Remote name or repository URL/path to publish to    |
+| `author`  | `string`   | —                  | Commit author and committer, as `"Name <email>"`    |
 | `force`   | `boolean`  | `false`            | Force push fresh commit with no previous history    |
 | `dryRun`  | `boolean`  | `false`            | Return staged changes without committing or pushing |
 | `verbose` | `boolean`  | `false`            | Log executed git commands                           |
 
 ## How It Works
 
-1. Resolves the remote origin repository URL from local git configuration.
+1. Resolves the target repository URL from git remote configuration or uses the provided remote
+   URL/path directly.
 2. Creates an isolated temporary directory and fetches the target branch (or initializes it if it
    doesn't exist).
-3. Clears the target branch index and stages the contents of `dist` (less `exclude` patterns)
+3. Clears the target branch index and stages the contents of `dist` (minus `exclude` patterns)
    directly via Git `work-tree`.
 4. Checks for differences (`git diff --cached --name-status`). If there are changes, commits and
-   pushes back to `origin`.
+   pushes back to the remote repository.
 5. Cleans up the temporary directory.
 
 > [!WARNING]  
@@ -116,10 +130,12 @@ if (changes) {
 
 ### Notes
 
-- Dot files included by default; use `-e` to exclude.
+- Dotfiles (except `.DS_Store`) are included by default; use `-e` to exclude.
 - Contents in target branch are emptied and replaced with the contents of `dist` (WYSIWYG).
 - If `.nojekyll` or `CNAME` files are required, add them to `dist`; use a post-build step if needed.
 - If the target branch does not exist, it will be created.
+- When `--remote` is a repository URL or path, running from within an existing git repository is not
+  required.
 
 ## License
 

package/cli.js

@@ -5,7 +5,7 @@ import { publish } from './index.js'
 
 const HELP = `Usage: oneclickpush [options]
 
-Replace the contents of a remote git branch with that of a 
+Replace the contents of a remote git branch with that of a
 local directory.
 
 Options:
@@ -14,15 +14,18 @@ Options:
                           (default: "**/.DS_Store")
   -b, --branch <name>     Target branch (default: "gh-pages")
   -m, --message <msg>     Commit message (default: "Updates")
-  -f, --force             Force push with no history
-  -n, --dry-run           Show what would change, without 
+  -r, --remote <name|url> Remote name or repo URL to publish to
+                          (default: "origin")
+  -a, --author <author>   Commit author, as "Name <email>"
+  -f, --force             Force push new commit with no history
+  -n, --dry-run           Show what would change, without
                           committing or pushing
   -v, --verbose           Log git commands
   -V, --version           Print version
   -h, --help              Show this help
 
---exclude takes glob patterns (*, **, ?) and can be repeated. 
-Patterns are matched against the full path, so use **/name to 
+--exclude takes glob patterns (*, **, ?) and can be repeated.
+Patterns are matched against the full path, so use **/name to
 match at any depth.`
 
 const { values: v } = parseArgs({
@@ -30,8 +33,10 @@ const { values: v } = parseArgs({
     dist: { type: 'string', short: 'd', default: '.' },
     exclude: { type: 'string', short: 'e', multiple: true, default: ['**/.DS_Store'] },
     branch: { type: 'string', short: 'b', default: 'gh-pages' },
-    force: { type: 'boolean', short: 'f', default: false },
     message: { type: 'string', short: 'm', default: 'Updates' },
+    remote: { type: 'string', short: 'r', default: 'origin' },
+    author: { type: 'string', short: 'a' },
+    force: { type: 'boolean', short: 'f', default: false },
     'dry-run': { type: 'boolean', short: 'n', default: false },
     verbose: { type: 'boolean', short: 'v', default: false },
     version: { type: 'boolean', short: 'V', default: false },

package/index.d.ts

@@ -16,7 +16,15 @@ export type OneclickpushOptions = {
    */
   message?: string
   /**
-   * Force push with no history
+   * Remote name of the current repo, or a repository URL or path
+   */
+  remote?: string
+  /**
+   * Commit author and committer as "Name <email>"
+   */
+  author?: string
+  /**
+   * Force push new commit with no history
    */
   force?: boolean
   /**
@@ -34,7 +42,9 @@ export type OneclickpushOptions = {
  * @prop {string[]} [exclude] Paths to leave out, relative to dist (default: `**\/.DS_Store`)
  * @prop {string} [branch="gh-pages"] Target branch
  * @prop {string} [message="Updates"] Commit message
- * @prop {boolean} [force=false] Force push with no history
+ * @prop {string} [remote="origin"] Remote name of the current repo, or a repository URL or path
+ * @prop {string} [author] Commit author and committer as "Name <email>"
+ * @prop {boolean} [force=false] Force push new commit with no history
  * @prop {boolean} [dryRun=false] Show what would change, without committing or pushing
  * @prop {boolean} [verbose=false] Log git commands
  */
@@ -49,6 +59,8 @@ export declare function publish({
   exclude,
   branch,
   message,
+  remote,
+  author,
   force,
   dryRun,
   verbose

package/index.js

@@ -10,7 +10,9 @@ import { join, resolve } from 'node:path'
  * @prop {string[]} [exclude] Paths to leave out, relative to dist (default: `**\/.DS_Store`)
  * @prop {string} [branch="gh-pages"] Target branch
  * @prop {string} [message="Updates"] Commit message
- * @prop {boolean} [force=false] Force push with no history
+ * @prop {string} [remote="origin"] Remote name of the current repo, or a repository URL or path
+ * @prop {string} [author] Commit author and committer as "Name <email>"
+ * @prop {boolean} [force=false] Force push new commit with no history
  * @prop {boolean} [dryRun=false] Show what would change, without committing or pushing
  * @prop {boolean} [verbose=false] Log git commands
  */
@@ -26,6 +28,8 @@ export async function publish({
   exclude = ['**/.DS_Store'],
   branch = 'gh-pages',
   message = 'Updates',
+  remote = 'origin',
+  author,
   force = false,
   dryRun = false,
   verbose = false
@@ -33,13 +37,34 @@ export async function publish({
   dist = resolve(dist)
   const run = promisify(execFile)
 
-  /** @type {(args: string[], cwd?: string) => Promise<string>} */
-  const git = async (args, cwd) => {
+  // Env vars beat git config, so this also overrides any identity already set in CI
+  /** @type {Record<string, string>} */
+  let identity = {}
+  if (author) {
+    const m = /^(.+?)\s*<(.+)>$/.exec(author)
+    if (!m) throw new Error('--author must look like "Name <email>"')
+    identity = {
+      GIT_AUTHOR_NAME: m[1],
+      GIT_AUTHOR_EMAIL: m[2],
+      GIT_COMMITTER_NAME: m[1],
+      GIT_COMMITTER_EMAIL: m[2]
+    }
+  }
+
+  /** @type {(args: string[], cwd?: string, env?: Record<string, string>) => Promise<string>} */
+  const git = async (args, cwd, env) => {
     if (verbose) console.error(`$ git ${args.join(' ')}`)
-    return (await run('git', args, { cwd })).stdout.trim()
+    return (await run('git', args, { cwd, env: { ...process.env, ...env } })).stdout.trim()
+  }
+
+  // A remote name resolves to its url; anything else is used as a url or path as-is
+  let url = remote
+  try {
+    url = await git(['remote', 'get-url', remote])
+  } catch {
+    if (/^[\w-]+$/.test(remote)) throw new Error(`Remote "${remote}" not found`)
   }
 
-  const url = await git(['config', '--get', 'remote.origin.url'])
   const tmp = await mkdtemp(join(tmpdir(), 'oneclickpush-'))
 
   try {
@@ -77,7 +102,7 @@ export async function publish({
     const status = await git(['diff', '--cached', '--name-status'], tmp)
     if (!status || dryRun) return status
 
-    await git(['commit', '-q', '-m', message], tmp)
+    await git(['commit', '-q', '-m', message], tmp, identity)
     await git(['push', '-q', ...(force ? ['--force'] : []), 'origin', branch], tmp)
     return status
   } finally {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneclickpush",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "One-click GitHub Pages deployer",
   "author": "Jason Lee <jason@zerodevx.com>",
   "scripts": {