wordmove-ng 6.0.2 → 6.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b938b4ef6d1ed30ecf48f1cbe1d48ba2f1a2ef223247189a3da3a0c1b840238
-  data.tar.gz: a3ffcdb129f255a82a7257f7d50a9d7c8b56195fd7e8a169ff04cceed8216281
+  metadata.gz: 3b2ca340ce83622a7faa03d89c41573efb50933bd3c85f5427eac9f9ae07ee91
+  data.tar.gz: 9183010aadcc92084a70839d140bd62604c8e4058aac8411b809f70558e14d7d
 SHA512:
-  metadata.gz: 7d8d9baa3cecea48ac16a2853c927695eb1ad865bc0df9efc01f5ba6d034e96afab4322eeae3da3b9a605584a5fe44ed4ff58c3995daea9d4b9f08de616720ac
-  data.tar.gz: 211ca5b52895d6fef092985a0bec08cd7bad97845c6579187699856e1d79339d510da596a60247bc3aa4296b1bdb7e85859cebbeda51a853b36335bdb86723b0
+  metadata.gz: 7411e375d8221a234dcb394ada25d0c3caa7e62225a328d5cd78d25f9d4a5be8887227844126d6045abd339b1c7c3b74966894d9fef5159c0e1fc1eab909a79e
+  data.tar.gz: a1914ff1d4a9ed0b533588bd1aca0b13157576e0e4d731c326edaf54db72916524d2402460350b3d0315d3ca623acf870d57c800b04a6c21955cd301cc333952

data/.github/workflows/release.yml

@@ -2,12 +2,12 @@
 #
 # 1. release-please watches master. From Conventional Commits it opens (and keeps
 #    updating) a "release PR" that bumps lib/wordmove/version.rb and CHANGELOG.md.
-#    Merging that PR creates the vX.Y.Z tag and the GitHub release.
-# 2. The publish job then builds the gem and pushes it to rubygems.org with
-#    trusted publishing (OIDC, no API key) and attaches the .gem to the release.
-#
-# The publish job also runs when a v* tag is pushed by hand, which is how the
-# very first release (v6.0.0) is cut.
+#    Merging that PR creates the vX.Y.Z tag and the GitHub release, using the
+#    RELEASE_PLEASE_TOKEN PAT so that the tag push triggers this workflow again.
+# 2. That tag push runs the publish job, which builds the gem, pushes it to
+#    rubygems.org with trusted publishing (OIDC, no API key) and attaches the
+#    .gem to the release. A v* tag pushed by hand at the head of master goes
+#    through the same job.
 #
 # One-time setup (see README "Releasing"):
 #   - rubygems.org: pending trusted publisher for gem wordmove-ng, repository
@@ -36,9 +36,6 @@ jobs:
     permissions:
       contents: write
       pull-requests: write
-    outputs:
-      release_created: ${{ steps.release.outputs.release_created }}
-      tag_name: ${{ steps.release.outputs.tag_name }}
     steps:
       # A fine-grained PAT (secret RELEASE_PLEASE_TOKEN, contents + pull-requests
       # read/write) instead of the built-in token: PRs opened with the built-in
@@ -52,14 +49,10 @@ jobs:
           manifest-file: .release-please-manifest.json
 
   publish:
-    needs: [release-please]
-    # Runs after release-please created a release, or on a manually pushed tag.
-    # The `always()` is needed because release-please is skipped on tag pushes.
-    if: >-
-      always() && (
-        needs.release-please.outputs.release_created == 'true' ||
-        startsWith(github.ref, 'refs/tags/v')
-      )
+    # Only on tag pushes. release-please's tag (created with the PAT) triggers
+    # this workflow like any other push, so publishing from the master run as
+    # well would race it and fail with "Tag vX.Y.Z has already been created".
+    if: startsWith(github.ref, 'refs/tags/v')
     runs-on: ubuntu-latest
     environment: release
     permissions:
@@ -80,7 +73,7 @@ jobs:
 
       - name: Verify the tag points at the head of master
         env:
-          TAG: ${{ needs.release-please.outputs.tag_name || github.ref_name }}
+          TAG: ${{ github.ref_name }}
         run: |
           git fetch --tags --force
           tag_commit="$(git rev-parse "refs/tags/$TAG^{commit}")"
@@ -104,7 +97,7 @@ jobs:
       - name: Attach the gem to the GitHub release
         env:
           GH_TOKEN: ${{ github.token }}
-          TAG: ${{ needs.release-please.outputs.tag_name || github.ref_name }}
+          TAG: ${{ github.ref_name }}
         # release-please creates the release itself; a hand-pushed tag has none yet.
         run: |
           if ! gh release view "$TAG" >/dev/null 2>&1; then

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "6.0.2"
+  ".": "6.0.3"
 }

data/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to wordmove-ng are documented here. The project follows
 are listed at https://github.com/welaika/wordmove/releases; the kokiddp fork's changes
 between 5.2.2 and this project are summarised under 6.0.0.
 
+## [6.0.3](https://github.com/tekgnosis-net/wordmove-ng/compare/v6.0.2...v6.0.3) (2026-09-30)
+
+
+### Documentation
+
+* expand the Ruby installation guide ([#7](https://github.com/tekgnosis-net/wordmove-ng/issues/7)) ([5972e2c](https://github.com/tekgnosis-net/wordmove-ng/commit/5972e2cf45f8ef6ebf1c2724b7637a8f4d319e11))
+
 ## [6.0.2](https://github.com/tekgnosis-net/wordmove-ng/compare/v6.0.1...v6.0.2) (2026-09-12)
 
 

data/README.md

@@ -35,7 +35,9 @@ in a few places where the old behaviour was unsafe. See [Upgrading from wordmove
 
 ## Installation
 
-Ruby 3.0 or newer is required.
+Ruby 3.0 or newer is required. If your system Ruby is older or missing, the docs walk
+through [installing Ruby](https://tekgnosis-net.github.io/wordmove-ng/installation/#ruby)
+with your package manager, rbenv, RVM, mise or Docker.
 
 ```bash
 gem install wordmove-ng
@@ -320,12 +322,12 @@ stored anywhere.
 1. Every push to `master` updates a "release PR" that bumps `lib/wordmove/version.rb` and
    `CHANGELOG.md` according to the commits since the last release.
 2. Merging that PR creates the `vX.Y.Z` tag and the GitHub release.
-3. The `publish` job in `.github/workflows/release.yml` then runs the test suite on the
-   tagged commit, builds the gem, pushes it to rubygems.org and attaches the `.gem` file to
-   the GitHub release.
+3. The tag push triggers the `publish` job in `.github/workflows/release.yml`, which runs
+   the test suite on the tagged commit, builds the gem, pushes it to rubygems.org and
+   attaches the `.gem` file to the GitHub release.
 
-Pushing a `v*` tag by hand at the head of `master` triggers the same publish job; that is
-how 6.0.0 was cut. Merge the release PR only when there is something worth shipping:
+Pushing a `v*` tag by hand at the head of `master` goes through the same publish job; that
+is how 6.0.0 was cut. Merge the release PR only when there is something worth shipping:
 release-please keeps proposing a patch release for any Conventional Commit, including
 `ci:` and `docs:` ones.
 

data/docs/contributing.md

@@ -38,9 +38,9 @@ Releases are automated by [release-please](https://github.com/googleapis/release
 
 1. Every push to `master` updates a "release PR" that bumps the version and the changelog from the commits since the last release. release-please proposes a patch release for any Conventional Commit, `ci:` and `docs:` included, so merge the PR only when there is something worth shipping.
 2. Merging it creates the `vX.Y.Z` tag and the GitHub release.
-3. The `publish` job in `.github/workflows/release.yml` re-runs the suite on the tagged commit, builds the gem, pushes it to rubygems.org and attaches the `.gem` file to the GitHub release.
+3. The tag push triggers the `publish` job in `.github/workflows/release.yml`, which re-runs the suite on the tagged commit, builds the gem, pushes it to rubygems.org and attaches the `.gem` file to the GitHub release.
 
-Pushing a `v*` tag by hand at the head of `master` triggers the same publish job.
+Pushing a `v*` tag by hand at the head of `master` goes through the same publish job.
 
 `master` is protected: changes land through pull requests whose `test` checks pass, and the rules apply to administrators too. release-please opens its PR with a fine-grained personal access token (secret `RELEASE_PLEASE_TOKEN`) because PRs opened with the built-in Actions token never trigger the checks.
 

data/docs/installation.md

@@ -11,11 +11,124 @@ nav_order: 2
 
 ## Ruby
 
-wordmove-ng needs **Ruby 3.0 or newer**. Check with `ruby --version`. If your system Ruby is older or missing, use a version manager:
+wordmove-ng needs **Ruby 3.0 or newer** and is tested on 3.0 through 4.0. Check what you have:
 
-- [rbenv](https://github.com/rbenv/rbenv#installation)
-- [RVM](https://rvm.io/)
-- [mise](https://mise.jdx.dev/) (`mise use -g ruby@3.4`)
+```bash
+ruby --version
+```
+
+If that prints 3.0 or newer you can skip to [the gem](#the-gem). Otherwise pick one of the routes below. A version manager is the usual choice: it leaves the system Ruby alone (several distributions depend on it), installs gems into your home directory without `sudo`, and lets you upgrade Ruby later without touching anything else. Any current 3.x works; `3.4` is a good default and is what the project itself uses.
+
+### Option A: your distribution's Ruby
+{: .no_toc }
+
+The quickest route when the packaged version is recent enough. Debian 12, Ubuntu 22.04 and later, Fedora and Arch all ship Ruby 3.x.
+
+```bash
+# Debian / Ubuntu
+sudo apt update && sudo apt install -y ruby-full build-essential
+# Fedora
+sudo dnf install -y ruby ruby-devel @development-tools
+# Arch
+sudo pacman -S ruby base-devel
+```
+
+Then install the gem for your user only, so no `sudo` is needed and the system stays untouched:
+
+```bash
+gem install --user-install wordmove-ng
+```
+
+`--user-install` puts executables under `~/.local/share/gem/ruby/<version>/bin` (older Rubies: `~/.gem/ruby/<version>/bin`). Add that directory to your `PATH` in `~/.bashrc` or `~/.zshrc`; `gem env` prints the exact path under `USER INSTALLATION DIRECTORY`.
+
+### Option B: rbenv
+{: .no_toc }
+
+Lightweight, shell-agnostic, and packaged everywhere. `rbenv` selects a Ruby; the `ruby-build` plugin compiles one.
+
+```bash
+# macOS
+brew install rbenv ruby-build
+# Debian / Ubuntu (rbenv from apt is often old; the git checkout below is current)
+sudo apt install -y git build-essential autoconf libssl-dev libyaml-dev zlib1g-dev libffi-dev libgmp-dev rustc
+git clone https://github.com/rbenv/rbenv.git ~/.rbenv
+git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
+~/.rbenv/bin/rbenv init      # prints the line to add to your shell profile; add it, then reopen the terminal
+```
+
+```bash
+rbenv install 3.4.11         # compiles Ruby, takes a few minutes
+rbenv global 3.4.11
+ruby --version
+gem install wordmove-ng
+rbenv rehash                 # makes the wordmove-ng executable visible
+```
+
+`rbenv install --list` shows the versions available; run `git -C ~/.rbenv/plugins/ruby-build pull` (or `brew upgrade ruby-build`) if a recent one is missing.
+
+### Option C: RVM
+{: .no_toc }
+
+Heavier than rbenv but familiar to many WordPress developers, and its gemsets isolate one project's gems from another's.
+
+```bash
+gpg --keyserver keyserver.ubuntu.com --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
+\curl -sSL https://get.rvm.io | bash -s stable
+source ~/.rvm/scripts/rvm    # or reopen the terminal
+```
+
+```bash
+rvm install 3.4.11
+rvm use 3.4.11 --default
+gem install wordmove-ng
+```
+
+RVM installs the build dependencies for you (it may ask for your `sudo` password once). To keep wordmove-ng in its own gemset: `rvm gemset create wordmove && rvm use 3.4.11@wordmove --default` before `gem install`. If you use the [cron script]({{ site.baseurl }}/automation/), set `RUBY_VERSION` to the same `ruby-3.4.11` or `ruby-3.4.11@wordmove` string.
+
+### Option D: mise
+{: .no_toc }
+
+One tool for Ruby, Node, PHP and more, with a single config file per project. Good if you already manage other runtimes with it.
+
+```bash
+curl https://mise.run | sh
+echo 'eval "$(~/.local/bin/mise activate bash)"' >> ~/.bashrc   # or: mise activate zsh >> ~/.zshrc
+exec $SHELL
+```
+
+```bash
+mise use --global ruby@3.4
+ruby --version
+gem install wordmove-ng
+```
+
+mise compiles Ruby through ruby-build as well, so on Linux install the same build packages listed under rbenv first; on macOS `brew install openssl@3 readline libyaml gmp autoconf`.
+
+### Docker
+{: .no_toc }
+
+If you would rather not install Ruby at all, run wordmove-ng from the official Ruby image. Mount your site and your SSH configuration, and make sure the peer tools are installed in the container:
+
+```bash
+docker run --rm -it \
+  -v "$PWD":/site -w /site \
+  -v "$HOME/.ssh":/root/.ssh:ro \
+  ruby:3.4 bash -c 'apt-get update -qq && apt-get install -y -qq rsync openssh-client mariadb-client >/dev/null \
+    && gem install -q wordmove-ng && wordmove-ng doctor'
+```
+
+For repeated use bake that into a small Dockerfile. Note that `local` in your movefile then means "inside the container": `wordpress_path` is `/site`, and the local database must be reachable from the container (`host: host.docker.internal` on Docker Desktop, or the compose service name).
+
+### Checking the result
+{: .no_toc }
+
+```bash
+ruby --version        # 3.0 or newer
+gem --version
+wordmove-ng --version
+```
+
+If `wordmove-ng` is not found right after installing, the executable directory is not in your `PATH` yet: open a new terminal, and for rbenv run `rbenv rehash`. `gem env` shows where executables were placed.
 
 ## The gem
 

data/lib/wordmove/version.rb

@@ -1,3 +1,3 @@
 module Wordmove
-  VERSION = "6.0.2".freeze
+  VERSION = "6.0.3".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wordmove-ng
 version: !ruby/object:Gem::Version
-  version: 6.0.2
+  version: 6.0.3
 platform: ruby
 authors:
 - Kumar