@wpelevator/wp-release 0.1.1 → 0.3.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,8 @@ 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`. |
+| `--readme-only` | off | Sync only the readme to `trunk/`, for updates between releases such as bumping `Tested up to`. Can't be combined with `--svn-tag`. |
+| `--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`. |
 
@@ -176,9 +177,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/`. `--readme-only` needs the readme. 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,10 +189,9 @@ 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.
+- `--readme-only` can't be combined with `--svn-tag`, since a tag is a release snapshot that a readme update never changes.
 - `--version` defaults to `--svn-tag`, then the `Version` header of the deployed files; when `--version` and `--svn-tag` are both set they must match.
+- Pre-release versions like `1.0.0-rc.1` can be tagged, but syncing one to `trunk/` warns, since trunk is for the development version.
 - `--trunk` without `--svn-tag` works but warns, because trunk then differs from the stable tag that WordPress.org serves downloads from.
 
 ### Exit codes

package/dist/commands/deploy-svn.js

@@ -28,7 +28,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 +43,9 @@ 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.
+  --readme-only           Sync only the readme to trunk/ (not with --svn-tag)
+  --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

package/dist/deploy-options.d.ts

@@ -37,8 +37,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. */
@@ -65,7 +63,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;

package/dist/deploy-options.js

@@ -62,15 +62,9 @@ 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.');
-    }
-    if (svnTag && isPrerelease(svnTag)) {
-        errors.push(`Pre-release version ${svnTag} can't be tagged on WordPress.org.`);
+    const { readmeOnly, svnTag, version, assets, assetsDir, slug } = options;
+    if (readmeOnly && svnTag) {
+        errors.push("--readme-only can't be combined with --svn-tag, since a tag is a release snapshot that a readme update never changes.");
     }
     if (svnTag && !isValidVersion(svnTag)) {
         errors.push(`SVN tag "${svnTag}" isn't a valid version, use only letters, digits, dots, dashes, plus signs and underscores.`);
@@ -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.');
     }
@@ -155,7 +146,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

@@ -134,7 +134,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>;
     /**
@@ -198,6 +200,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

@@ -277,7 +277,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 +290,7 @@ export class SvnDeploy {
         }
         if (tagPath) {
             await this.svn.copy({
-                from: 'trunk',
+                from: this.needsFiles() ? 'trunk' : this.getTrunkUrl(),
                 to: tagPath,
                 cwd: workingCopy,
             });
@@ -458,6 +460,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.
      *

package/package.json

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