@wpelevator/wp-release 0.1.0 → 0.2.0

package/README.md

@@ -56,6 +56,7 @@ Each concept has one name, written in the syntax of each interface:
 | Git tag to compare | `--git-tag <tag>` | | `gitTag` | Git tag checked by `version-check`. |
 | SVN tag to create | `--svn-tag <version>` | `svn-tag` | `svnTag` | Tag written by `deploy-svn`, distinct from a git tag. |
 | SVN repository | `--svn-url <url>` | `svn-url` | `svnUrl` | Deploy destination. |
+| SVN credentials | `--svn-username <name>`, `SVN_USERNAME` and `SVN_PASSWORD` env vars | `svn-username`, `svn-password` | `svnUsername`, `svnPassword` | Needed only to commit. There's no password flag, since it would show in the process list; the action inputs and library options fall back to the env vars. |
 | Assets sync | `--no-assets` to skip | `assets: false` to skip | `assets` | Booleans are positive in the library and the action; `--no-assets` is only the CLI negation, never `noAssets` or a `no-assets` input. |
 
 CLI JSON results use camelCase keys like `zipPath`, and GitHub Action outputs use kebab-case like `zip-path`. Library classes are named after the capability (`SvnDeploy`, `Svn`) without repeating "release".
@@ -152,8 +153,7 @@ wp-release version-check --constant MY_PLUGIN_VERSION --git-tag v1.2.0
 | Flag | Default | Writes |
 |---|---|---|
 | `--trunk` | off | Sync the full source directory to `trunk/` |
-| `--readme-only` | off | Sync only the readme to `trunk/`, for updates between releases such as bumping `Tested up to` |
-| `--svn-tag <version>` | off | Copy `trunk/` to `tags/<version>`; requires `--trunk`. A leading `v` is stripped, so `v1.2.0` creates `tags/1.2.0`. |
+| `--svn-tag <version>` | off | Copy `trunk/` to `tags/<version>`. Without `--trunk`, the tag is copied from the repository's current `trunk/`. A leading `v` is stripped, so `v1.2.0` creates `tags/1.2.0`. |
 | `--assets-dir <dir>` | not set | Sync this directory with banners, icons and screenshots to the SVN `assets/` directory. There's no default directory, so assets are only deployed when this is set, and it must exist. |
 | `--no-assets` | | Skip the `--assets-dir` sync for one run, for example when a config always passes `--assets-dir`. |
 
@@ -163,9 +163,6 @@ Typical runs:
 # Deploy 1.2.0 to trunk and the tag, and update the assets
 wp-release deploy-svn dist --trunk --svn-tag 1.2.0 --assets-dir .wordpress-org
 
-# Update only the readme between releases
-wp-release deploy-svn dist --readme-only
-
 # Update only the assets
 wp-release deploy-svn --assets-dir .wordpress-org
 
@@ -176,9 +173,9 @@ wp-release deploy-svn --from-zip my-plugin.1.2.0.zip --trunk --svn-tag 1.2.0
 How a deploy works:
 
 1. The options are validated, including the slug, version and readme name, before they're used in URLs or paths.
-2. With `--trunk`, the files must be a plugin whose `Version` header matches the version, and with `--svn-tag` the readme `Stable tag` must match too. `--readme-only` needs the readme. Nothing is checked out when a check fails.
+2. With `--trunk`, the files must be a plugin whose `Version` header matches the version, and with `--svn-tag` the readme `Stable tag` must match too. A tag-only run doesn't check the files, since it tags whatever is in `trunk/`. Nothing is checked out when a check fails.
 3. The repository is checked out sparsely into a new temporary directory, with only the directories that the flags write to. A missing `assets/` (or `trunk/`, `tags/`) directory is created. The deploy stops when `tags/<version>` exists, unless `--force` replaces it.
-4. The files are synced in Node.js, without `rsync`: new and changed files are copied, files that are no longer selected are deleted, and `svn add` and `svn delete` stage them, including files that svn ignores by default. `trunk/` is then copied to the tag with `svn copy`.
+4. The files are synced in Node.js, without `rsync`: new and changed files are copied, files that are no longer selected are deleted, and `svn add` and `svn delete` stage them, including files that svn ignores by default. `trunk/` is then copied to the tag with `svn copy`, from the working copy when trunk was written and from the repository otherwise.
 5. Asset images get `svn:mime-type` set for PNG, JPEG, GIF and SVG, the formats that WordPress.org documents for plugin assets. Other formats keep the type that svn assigns.
 6. When `svn status` is empty, the deploy ends without a commit. A dry run logs the status and stops before the commit. Otherwise the changes are committed, and the temporary directory is always removed.
 
@@ -188,8 +185,6 @@ Credentials are only needed for the commit, not for dry runs, no-op runs or `fil
 
 Validation:
 
-- `--trunk` and `--readme-only` can't be combined.
-- `--readme-only` is rejected when `GITHUB_REF` is a tag, since a readme-only update from a release tag usually means the build was forgotten.
 - Pre-release versions like `1.0.0-rc.1` are never tagged.
 - `--version` defaults to `--svn-tag`, then the `Version` header of the deployed files; when `--version` and `--svn-tag` are both set they must match.
 - `--trunk` without `--svn-tag` works but warns, because trunk then differs from the stable tag that WordPress.org serves downloads from.
@@ -309,8 +304,8 @@ The `wpelevator-source` export condition points at `src/index.ts`. The tests and
 
 | Tool | What it does | How `wp-release` differs |
 |---|---|---|
-| [10up WordPress.org plugin deploy](https://github.com/10up/action-wordpress-plugin-deploy) and [readme/asset update](https://github.com/10up/action-wordpress-plugin-asset-update) actions | Two separate GitHub Actions configured through env vars. A deploy always syncs the build to `trunk/` and copies it to the tag; readme and asset updates need the second action. Assets come from `.wordpress-org` by default, and files are selected with `.distignore` or `.gitattributes`. Files are synced with `rsync`. | One `deploy-svn` command with independent write flags, so a release, a readme-only update and an assets-only update are the same command with different flags. Runs locally and in any CI, not only GitHub Actions, and syncs in Node.js without `rsync`. Checks that the `Version` header, readme `Stable tag` and SVN tag agree before writing, which the 10up actions don't. Assets are deployed only when `--assets-dir` is passed, instead of always syncing `.wordpress-org` when it exists, so a plugin's own `assets/` folder is never uploaded by accident. Adds `--exclude` for patterns without an ignore file and `--from-zip` to deploy the exact files of a ZIP. |
-| [`grunt-wp-deploy`](https://github.com/stephenharris/grunt-wp-deploy) | Grunt task with `deploy_trunk` and `deploy_tag` booleans, interactive password prompts and a `Stable tag` check. | No Grunt dependency and never interactive. `--readme-only` is a separate flag, where `grunt-wp-deploy` can only update trunk with the full build. Assets are independent of trunk writes. |
+| [10up WordPress.org plugin deploy](https://github.com/10up/action-wordpress-plugin-deploy) and [readme/asset update](https://github.com/10up/action-wordpress-plugin-asset-update) actions | Two separate GitHub Actions configured through env vars. A deploy always syncs the build to `trunk/` and copies it to the tag; readme and asset updates need the second action. Assets come from `.wordpress-org` by default, and files are selected with `.distignore` or `.gitattributes`. Files are synced with `rsync`. | One `deploy-svn` command with independent write flags, so a release, a tag-only run and an assets-only update are the same command with different flags. Runs locally and in any CI, not only GitHub Actions, and syncs in Node.js without `rsync`. Checks that the `Version` header, readme `Stable tag` and SVN tag agree before writing, which the 10up actions don't. Assets are deployed only when `--assets-dir` is passed, instead of always syncing `.wordpress-org` when it exists, so a plugin's own `assets/` folder is never uploaded by accident. Adds `--exclude` for patterns without an ignore file and `--from-zip` to deploy the exact files of a ZIP. |
+| [`grunt-wp-deploy`](https://github.com/stephenharris/grunt-wp-deploy) | Grunt task with `deploy_trunk` and `deploy_tag` booleans, interactive password prompts and a `Stable tag` check. | No Grunt dependency and never interactive. Tagging is independent of syncing trunk, and assets are independent of both. |
 | [codeinwp theme deploy](https://github.com/codeinwp/action-wordpress-theme-deploy) | Fork of the 10up plugin action that commits themes to the themes SVN repository. | Doesn't deploy themes. Theme releases are ZIP uploads on WordPress.org; `zip` builds the upload with the theme folder as the root. |
 | [`wp dist-archive`](https://github.com/wp-cli/dist-archive-command) | WP-CLI command that zips a project using `.distignore`, with `--plugin-dirname` and `--filename-format`. | Same `.distignore` file and `{name}.{version}` style filename format, but needs only Node.js instead of PHP and WP-CLI. `.distignore` is matched with full gitignore syntax, including `!` negation, and `--distignore` / `--exclude` let you point at another ignore file or add patterns on the command line. Builds are reproducible, and `--checksums` writes a manifest next to the ZIP. |
 | [`wp plugin verify-checksums`](https://developer.wordpress.org/cli/commands/plugin/verify-checksums/) | WP-CLI command that checks installed plugins against the WordPress.org checksums API. | Reads the same manifest format, but from a file, so it also works for plugins and themes that aren't hosted on WordPress.org and for build directories in CI. `checksums` writes the manifest that WordPress.org generates for its own plugins. |

package/dist/commands/deploy-svn.d.ts

@@ -41,9 +41,6 @@ declare const _default: {
         trunk: {
             type: "boolean";
         };
-        'readme-only': {
-            type: "boolean";
-        };
         'svn-tag': {
             type: "string";
         };

package/dist/commands/deploy-svn.js

@@ -19,7 +19,6 @@ export function getDeployInputFromArgs(input) {
         slug: getString(values, 'slug'),
         version: getString(values, 'version'),
         trunk: flag('trunk'),
-        readmeOnly: flag('readme-only'),
         svnTag: getString(values, 'svn-tag'),
         assets: getBoolean(values, 'no-assets') ? false : undefined,
         assetsDir: getString(values, 'assets-dir'),
@@ -28,7 +27,6 @@ export function getDeployInputFromArgs(input) {
         ...getFileSelectionInput(values),
         svnUrl: getString(values, 'svn-url'),
         svnUsername: getString(values, 'svn-username'),
-        gitRef: process.env.GITHUB_REF,
         message: getString(values, 'message'),
         force: flag('force'),
         dryRun: flag('dry-run'),
@@ -44,9 +42,8 @@ export default {
 
 Writes (none by default, assets only with --assets-dir):
   --trunk                 Sync the full source directory to trunk/
-  --readme-only           Sync only the readme to trunk/ (not with --trunk)
-  --svn-tag <version>     Copy trunk/ to tags/<version> (requires --trunk).
-                          A leading "v" is stripped.
+  --svn-tag <version>     Copy trunk/ to tags/<version>, with or without
+                          --trunk. A leading "v" is stripped.
   --assets-dir <dir>      Sync this directory with banners, icons and
                           screenshots to assets/
   --no-assets             Don't sync --assets-dir for this run
@@ -73,14 +70,11 @@ or rejected.
 Examples:
   wp-release deploy-svn dist --trunk --svn-tag 1.2.0 --assets-dir .wordpress-org
       Deploy 1.2.0 to trunk and the tag, and update the assets
-  wp-release deploy-svn dist --readme-only
-      Update only the readme
   wp-release deploy-svn --assets-dir .wordpress-org
       Update only the assets`,
     options: {
         ...sourceDirArgs,
         trunk: { type: 'boolean' },
-        'readme-only': { type: 'boolean' },
         'svn-tag': { type: 'string' },
         'assets-dir': { type: 'string' },
         'no-assets': { type: 'boolean' },

package/dist/deploy-options.d.ts

@@ -13,8 +13,6 @@ export interface DeployInput {
     version?: string;
     /** Sync the full source directory to trunk/. */
     trunk?: boolean;
-    /** Sync only the readme to trunk/. */
-    readmeOnly?: boolean;
     /** Copy trunk/ to tags/<svnTag>. */
     svnTag?: string;
     /** Sync the assets directory, defaults to on when assetsDir is set. */
@@ -37,8 +35,6 @@ export interface DeployInput {
     svnUsername?: string;
     /** SVN password, defaults to the SVN_PASSWORD env var. */
     svnPassword?: string;
-    /** Git ref of the run, like refs/tags/1.2.0. */
-    gitRef?: string;
     /** SVN commit message. */
     message?: string;
     /** Replace an existing tag. */
@@ -54,7 +50,6 @@ export interface DeployOptions extends FileSelection {
     slug: string;
     version: string | null;
     trunk: boolean;
-    readmeOnly: boolean;
     svnTag: string | null;
     assets: boolean;
     assetsDir: string | null;
@@ -65,7 +60,6 @@ export interface DeployOptions extends FileSelection {
     svnUsername: string | null;
     /** Never logged or printed. */
     svnPassword: string | null;
-    gitRef: string | null;
     message: string | null;
     force: boolean;
     dryRun: boolean;
@@ -123,7 +117,7 @@ export declare function getDeployOptionErrors(options: DeployOptions): string[];
  */
 export declare function getDeployOptionWarnings(options: DeployOptions): string[];
 /**
- * Apply defaults to deploy options and validate them. Trunk, readme and tag
+ * Apply defaults to deploy options and validate them. Trunk and tag
  * writes happen only when requested, and assets are synced whenever an
  * assets directory is set, unless turned off. The version defaults to the
  * SVN tag; without either, SvnDeploy reads the Version header of the

package/dist/deploy-options.js

@@ -62,13 +62,7 @@ function isValidFilename(name) {
  */
 export function getDeployOptionErrors(options) {
     const errors = [];
-    const { trunk, readmeOnly, svnTag, version, assets, assetsDir, slug } = options;
-    if (svnTag && !trunk) {
-        errors.push('--svn-tag requires --trunk, since the tag is copied from trunk.');
-    }
-    if (trunk && readmeOnly) {
-        errors.push('Use either --trunk or --readme-only, not both.');
-    }
+    const { svnTag, version, assets, assetsDir, slug } = options;
     if (svnTag && isPrerelease(svnTag)) {
         errors.push(`Pre-release version ${svnTag} can't be tagged on WordPress.org.`);
     }
@@ -81,9 +75,6 @@ export function getDeployOptionErrors(options) {
     if (svnTag && version && svnTag !== version) {
         errors.push(`SVN tag ${svnTag} doesn't match version ${version}.`);
     }
-    if (readmeOnly && isTagRef(options.gitRef)) {
-        errors.push(`--readme-only isn't allowed when running for tag ${options.gitRef}. Did you mean --trunk --svn-tag?`);
-    }
     if (assets && !assetsDir) {
         errors.push('Syncing assets requires --assets-dir.');
     }
@@ -118,7 +109,7 @@ export function getDeployOptionWarnings(options) {
     return warnings;
 }
 /**
- * Apply defaults to deploy options and validate them. Trunk, readme and tag
+ * Apply defaults to deploy options and validate them. Trunk and tag
  * writes happen only when requested, and assets are synced whenever an
  * assets directory is set, unless turned off. The version defaults to the
  * SVN tag; without either, SvnDeploy reads the Version header of the
@@ -139,7 +130,6 @@ export function resolveDeployOptions(input = {}) {
         slug,
         version: input.version ? normalizeTag(input.version) : svnTag,
         trunk: Boolean(input.trunk),
-        readmeOnly: Boolean(input.readmeOnly),
         assets: input.assets ?? Boolean(assetsDir),
         svnTag,
         sourceDir,
@@ -155,7 +145,6 @@ export function resolveDeployOptions(input = {}) {
         svnUrl: (input.svnUrl || SVN_URL).replace('{slug}', slug),
         svnUsername: input.svnUsername || process.env.SVN_USERNAME || null,
         svnPassword: input.svnPassword || process.env.SVN_PASSWORD || null,
-        gitRef: input.gitRef || null,
         message: input.message || null,
         force: Boolean(input.force),
         dryRun: Boolean(input.dryRun),

package/dist/svn-deploy.d.ts

@@ -73,8 +73,7 @@ export declare class SvnDeploy {
     /**
      * Check the plugin files before anything is written. A trunk sync needs
      * a plugin with a Version header that matches the version, and with an
-     * SVN tag also a readme Stable tag that matches. Readme-only updates need
-     * the readme.
+     * SVN tag also a readme Stable tag that matches.
      *
      * @throws {ValidationError} When the files or versions don't match.
      */
@@ -134,7 +133,9 @@ export declare class SvnDeploy {
      */
     setAssetMimeTypes(): Promise<void>;
     /**
-     * Copy trunk to the SVN tag, replacing an existing tag with force.
+     * Copy trunk to the SVN tag, replacing an existing tag with force. Trunk
+     * is copied from the working copy when this run writes to it, and from the
+     * repository otherwise, so that tagging doesn't need a trunk checkout.
      */
     copyTag(): Promise<void>;
     /**
@@ -183,7 +184,7 @@ export declare class SvnDeploy {
     /**
      * Check if the deploy reads plugin files, which assets-only runs don't.
      *
-     * @return Whether trunk or the readme is written.
+     * @return Whether trunk is written.
      */
     needsFiles(): boolean;
     /**
@@ -198,6 +199,12 @@ export declare class SvnDeploy {
      * @return Rules description, empty without rules.
      */
     describeRules(): string;
+    /**
+     * Get the repository URL of trunk.
+     *
+     * @return Trunk URL without a double slash.
+     */
+    getTrunkUrl(): string;
     /**
      * Get the path of the tag in the working copy.
      *

package/dist/svn-deploy.js

@@ -9,7 +9,7 @@ import { CredentialsError, ValidationError } from "./errors.js";
 import { loadFileRules, selectFiles } from "./file-selection.js";
 import { readPackageMeta } from "./package-meta.js";
 import { Svn } from "./svn.js";
-import { copyFileIfChanged, syncDirectory } from "./sync.js";
+import { syncDirectory } from "./sync.js";
 import { extractZip } from "./unzip.js";
 import { findVersionMismatches } from "./version-check.js";
 /**
@@ -97,35 +97,27 @@ export class SvnDeploy {
     /**
      * Check the plugin files before anything is written. A trunk sync needs
      * a plugin with a Version header that matches the version, and with an
-     * SVN tag also a readme Stable tag that matches. Readme-only updates need
-     * the readme.
+     * SVN tag also a readme Stable tag that matches.
      *
      * @throws {ValidationError} When the files or versions don't match.
      */
     async checkVersions() {
-        const { trunk, readmeOnly, svnTag, slug, readme } = this.options;
+        const { trunk, svnTag, slug } = this.options;
         const sourceDir = this.filesDir ?? this.options.sourceDir;
-        if (trunk || readmeOnly) {
+        if (trunk) {
             const meta = await this.readPluginMeta(sourceDir);
-            if (readmeOnly && !meta.readme) {
-                throw new ValidationError(`${readme} doesn't exist in ${sourceDir}.`);
-            }
-            if (trunk) {
-                const { version, mismatches } = await findVersionMismatches({
-                    sourceDir,
-                    meta,
-                    slug,
-                    version: this.options.version,
-                    stableTag: Boolean(svnTag),
-                });
-                this.version = version;
-                if (mismatches.length) {
-                    throw new ValidationError(mismatches
-                        .map(({ message }) => message)
-                        .join('\n'));
-                }
-                this.logger.info(`Deploying version ${version}.`);
+            const { version, mismatches } = await findVersionMismatches({
+                sourceDir,
+                meta,
+                slug,
+                version: this.options.version,
+                stableTag: Boolean(svnTag),
+            });
+            this.version = version;
+            if (mismatches.length) {
+                throw new ValidationError(mismatches.map(({ message }) => message).join('\n'));
             }
+            this.logger.info(`Deploying version ${version}.`);
         }
     }
     /**
@@ -195,7 +187,7 @@ export class SvnDeploy {
      * additions, deletions and asset MIME types, then copy trunk to the tag.
      */
     async sync() {
-        const { trunk, readmeOnly, assets, readme } = this.options;
+        const { trunk, assets } = this.options;
         const workingCopy = this.getWorkingCopy();
         const sourceDir = this.filesDir ?? this.options.sourceDir;
         if (trunk) {
@@ -205,9 +197,6 @@ export class SvnDeploy {
                 targetDir: join(workingCopy, 'trunk'),
             });
         }
-        if (readmeOnly) {
-            await copyFileIfChanged(join(sourceDir, readme), join(workingCopy, 'trunk', readme));
-        }
         if (assets) {
             await this.syncAssets();
         }
@@ -277,7 +266,9 @@ export class SvnDeploy {
         }
     }
     /**
-     * Copy trunk to the SVN tag, replacing an existing tag with force.
+     * Copy trunk to the SVN tag, replacing an existing tag with force. Trunk
+     * is copied from the working copy when this run writes to it, and from the
+     * repository otherwise, so that tagging doesn't need a trunk checkout.
      */
     async copyTag() {
         const tagPath = this.getTagPath();
@@ -288,7 +279,7 @@ export class SvnDeploy {
         }
         if (tagPath) {
             await this.svn.copy({
-                from: 'trunk',
+                from: this.needsFiles() ? 'trunk' : this.getTrunkUrl(),
                 to: tagPath,
                 cwd: workingCopy,
             });
@@ -376,7 +367,7 @@ export class SvnDeploy {
      * @return Planned changes, in order.
      */
     getPlan() {
-        const { svnUrl, trunk, readmeOnly, assets, assetsDir, readme, force } = this.options;
+        const { svnUrl, trunk, assets, assetsDir, force } = this.options;
         const tagPath = this.getTagPath();
         const message = this.options.message ?? this.getDefaultMessage();
         const plan = [
@@ -386,7 +377,6 @@ export class SvnDeploy {
             tagPath && !force && `Stop if ${tagPath} already exists`,
             tagPath && force && `Replace ${tagPath} if it exists`,
             trunk && `Sync ${this.describeSource()} to trunk/`,
-            readmeOnly && `Copy ${readme} to trunk/`,
             tagPath && `Copy trunk/ to ${tagPath}`,
             assets && `Sync ${assetsDir} to assets/`,
             this.options.dryRun
@@ -402,9 +392,9 @@ export class SvnDeploy {
      * @return Relative paths with their SVN checkout depth.
      */
     getCheckoutPaths() {
-        const { trunk, readmeOnly, svnTag, assets } = this.options;
+        const { trunk, svnTag, assets } = this.options;
         const paths = [];
-        if (trunk || readmeOnly) {
+        if (trunk) {
             paths.push({ path: 'trunk', depth: 'infinity' });
         }
         if (svnTag) {
@@ -421,16 +411,16 @@ export class SvnDeploy {
      * @return Whether to check out and commit.
      */
     hasWrites() {
-        const { trunk, readmeOnly, svnTag, assets } = this.options;
-        return Boolean(trunk || readmeOnly || svnTag || assets);
+        const { trunk, svnTag, assets } = this.options;
+        return Boolean(trunk || svnTag || assets);
     }
     /**
      * Check if the deploy reads plugin files, which assets-only runs don't.
      *
-     * @return Whether trunk or the readme is written.
+     * @return Whether trunk is written.
      */
     needsFiles() {
-        return this.options.trunk || this.options.readmeOnly;
+        return this.options.trunk;
     }
     /**
      * Describe the files that are synced, including the ignore rules.
@@ -458,6 +448,14 @@ export class SvnDeploy {
         ];
         return rules.filter(Boolean).join(', ');
     }
+    /**
+     * Get the repository URL of trunk.
+     *
+     * @return Trunk URL without a double slash.
+     */
+    getTrunkUrl() {
+        return `${this.options.svnUrl.replace(/\/+$/, '')}/trunk`;
+    }
     /**
      * Get the path of the tag in the working copy.
      *
@@ -471,15 +469,11 @@ export class SvnDeploy {
         return null;
     }
     getDefaultMessage() {
-        const { trunk, readmeOnly, svnTag, assets } = this.options;
+        const { trunk, svnTag, assets } = this.options;
         if (svnTag) {
             return `Release version ${svnTag}`;
         }
-        const parts = [
-            trunk && 'trunk',
-            readmeOnly && 'readme',
-            assets && 'assets',
-        ];
+        const parts = [trunk && 'trunk', assets && 'assets'];
         return `Update ${parts.filter(Boolean).join(' and ')}`;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wpelevator/wp-release",
-	"version": "0.1.0",
+	"version": "0.2.0",
 	"description": "Package, checksum, verify and version-check WordPress plugins and themes, and deploy plugins to WordPress.org SVN",
 	"license": "MIT",
 	"repository": {