git-deploy-ng 0.8.0 → 0.9.0

data/spec/commands_spec.rb

@@ -21,6 +21,28 @@ describe GitDeploy do
     end
   end
 
+  describe '#download' do
+    it 'copies remote files into the local app directory' do
+      instance = described_class.new([], remote: 'production', noop: true)
+      downloads = {}
+
+      allow(instance).to receive(:scp_download) { |files| downloads.merge!(files) }
+      instance.send(:git_config)['remote -v'] = "production\tgit@example.com:/apps/demo (fetch)"
+
+      instance.download('log/deploy.log')
+
+      expect(downloads['/apps/demo/log/deploy.log']).to eq('log/deploy.log')
+    end
+
+    it 'requires a remote' do
+      instance = described_class.new([], noop: true)
+
+      expect {
+        instance.download('index.html')
+      }.to output(/Specify a remote with -r/).to_stderr.and raise_error(SystemExit)
+    end
+  end
+
   describe '#restart' do
     it 'runs the deploy restart script on the server' do
       instance = described_class.new([], remote: 'production', noop: true)

data/spec/configuration_spec.rb

@@ -84,6 +84,16 @@ describe GitDeploy::Configuration do
       it { expect(subject.deploy_to).to eq('~/path/to/app') }
     end
 
+    context "scp-style relative path" do
+      it 'resolves against the remote home directory' do
+        instance = GitDeploy.new([], remote: 'production', noop: true)
+        instance.send(:git_config)['remote -v'] = "production\tgit@example.com:apps/myapp (fetch)"
+        allow(instance).to receive(:run).with('echo $HOME').and_return("/home/git\n")
+
+        expect(instance.send(:deploy_to)).to eq('/home/git/apps/myapp')
+      end
+    end
+
     context "pushurl only" do
       before {
         remote = options.fetch(:remote)

data/spec/documentation_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'Documentation' do
+  it 'ships README.md and AGENTS.md instead of README.markdown' do
+    expect(File).to exist('README.md')
+    expect(File).to exist('AGENTS.md')
+    expect(File).not_to exist('README.markdown')
+  end
+
+  it 'documents required remote in README' do
+    readme = File.read('README.md')
+    expect(readme).to include('-r')
+    expect(readme).to include('AGENTS.md')
+  end
+end

data/spec/generator_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'tmpdir'
+require 'fileutils'
 require 'git_deploy/generator'
 
 describe GitDeploy::Generator do
@@ -11,6 +12,80 @@ describe GitDeploy::Generator do
         expect(File.executable?('deploy/after_push')).to be true
         expect(File.executable?('deploy/restart')).to be true
         expect(File.executable?('deploy/before_restart')).to be true
+        expect(File.read('deploy/restart')).to include('Passenger')
+      end
+    end
+  end
+
+  it 'generates PHP/composer scripts with the php-composer template' do
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        described_class.start(['--template', 'php-composer'])
+
+        expect(File.read('deploy/before_restart')).to include('composer install')
+        expect(File.read('deploy/restart')).to include('PHP')
+      end
+    end
+  end
+
+  it 'rejects unknown templates' do
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        expect {
+          described_class.start(['--template', 'django'])
+        }.to output(/Unknown template/).to_stderr.and raise_error(SystemExit)
+      end
+    end
+  end
+
+  it 'rejects path traversal in template names' do
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        expect {
+          described_class.start(['--template', '../rails-passenger'])
+        }.to output(/Unknown template/).to_stderr.and raise_error(SystemExit)
+      end
+    end
+  end
+
+  it 'refuses to run when deploy exists as a file' do
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        File.write('deploy', '#!/bin/sh')
+
+        expect {
+          described_class.start([])
+        }.to output(/deploy.*is a file/).to_stderr.and raise_error(SystemExit)
+
+        expect(File.directory?('deploy')).to be false
+      end
+    end
+  end
+
+  it 'warns and preserves existing files when deploy is not empty' do
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        FileUtils.mkdir_p('deploy')
+        File.write('deploy/custom', 'keep me')
+
+        expect {
+          described_class.start([])
+        }.to output(/already exists/).to_stdout
+
+        expect(File.read('deploy/custom')).to eq('keep me')
+        expect(File.executable?('deploy/after_push')).to be true
+      end
+    end
+  end
+
+  it 'generates a PHP restart script that fails when reload fails' do
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        described_class.start(['--template', 'php-composer'])
+
+        restart = File.read('deploy/restart')
+        expect(restart).not_to include('|| true')
+        expect(restart).to include('exit 1')
       end
     end
   end

data/spec/hooks_spec.rb

@@ -8,11 +8,26 @@ describe GitDeploy do
 
       allow(instance).to receive(:scp_upload) { |files| uploads.merge!(files) }
       allow(instance).to receive(:run)
+      allow(instance).to receive(:run_test).and_return(false)
       instance.send(:git_config)['remote -v'] = "production\tgit@example.com:/apps/demo (fetch)"
 
       instance.hooks
 
       expect(uploads.values).to include('/apps/demo/.git/hooks/post-receive')
     end
+
+    it 'requires a remote name' do
+      instance = described_class.new([], noop: true)
+
+      expect { instance.hooks }.to output(/Specify a remote with -r/).to_stderr.and raise_error(SystemExit)
+    end
+
+    it 'refuses to overwrite an existing post-receive hook without --force' do
+      instance = described_class.new([], remote: 'production', noop: true)
+      instance.send(:git_config)['remote -v'] = "production\tgit@example.com:/apps/demo (fetch)"
+      allow(instance).to receive(:run_test).with("[ -f /apps/demo/.git/hooks/post-receive ]").and_return(true)
+
+      expect { instance.hooks }.to output(/already has a post-receive hook/).to_stderr.and raise_error(SystemExit)
+    end
   end
 end

data/spec/remote_path_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'git_deploy/remote_path'
+
+describe GitDeploy::RemotePath do
+  describe '.raw_path' do
+    it 'returns a relative path from scp-style remotes' do
+      expect(described_class.raw_path('git@example.com:apps/myapp')).to eq('apps/myapp')
+    end
+
+    it 'returns an absolute path from scp-style remotes' do
+      expect(described_class.raw_path('git@example.com:/apps/myapp')).to eq('/apps/myapp')
+    end
+
+    it 'returns a home-relative path from scp-style remotes' do
+      expect(described_class.raw_path('git@example.com:~/apps/myapp')).to eq('~/apps/myapp')
+    end
+
+    it 'returns the path from ssh URLs' do
+      expect(described_class.raw_path('ssh://git@example.com:88/apps/myapp')).to eq('/apps/myapp')
+    end
+
+    it 'aborts when the url is missing' do
+      expect {
+        described_class.raw_path(nil)
+      }.to output(/No deploy remote URL configured/).to_stderr.and raise_error(SystemExit)
+    end
+  end
+
+  describe '.deploy_path' do
+    it 'joins relative paths with the remote home directory' do
+      expect(described_class.deploy_path('git@example.com:apps/myapp') { '/home/git' }).
+        to eq('/home/git/apps/myapp')
+    end
+
+    it 'leaves absolute paths unchanged' do
+      expect(described_class.deploy_path('git@example.com:/var/www/app', home: '/home/git')).
+        to eq('/var/www/app')
+    end
+
+    it 'leaves home-relative paths unchanged' do
+      expect(described_class.deploy_path('git@example.com:~/apps/myapp', home: '/home/git')).
+        to eq('~/apps/myapp')
+    end
+  end
+end

data/spec/setup_spec.rb

@@ -4,9 +4,13 @@ describe GitDeploy do
   describe '#setup' do
     let(:instance) { described_class.new([], remote: 'production', noop: true, shared: false, sudo: false) }
     let(:commands) { [] }
+    let(:run_tests) { {} }
 
     before do
-      allow(instance).to receive(:run_test).and_return(false)
+      allow(instance).to receive(:run_test) do |cmd|
+        run_tests[cmd] = false if run_tests[cmd].nil?
+        run_tests[cmd]
+      end
       allow(instance).to receive(:run) do |cmd = nil, **_opts, &block|
         cmd = block.call([]) if block
         commands << cmd
@@ -15,6 +19,49 @@ describe GitDeploy do
       instance.send(:git_config)['remote -v'] = "production\tgit@example.com:/apps/demo (fetch)"
     end
 
+    it 'requires a remote name' do
+      instance = described_class.new([], noop: true)
+
+      expect { instance.setup }.to output(/Specify a remote with -r/).to_stderr.and raise_error(SystemExit)
+    end
+
+    it 'refuses to overwrite an existing post-receive hook without --force' do
+      run_tests["[ -f /apps/demo/.git/hooks/post-receive ]"] = true
+
+      expect { instance.setup }.to output(/already has a post-receive hook/).to_stderr.and raise_error(SystemExit)
+    end
+
+    it 'proceeds when post-receive exists and --force is given' do
+      forced = described_class.new([], remote: 'production', noop: true, shared: false, sudo: false, force: true)
+      allow(forced).to receive(:run_test) do |cmd|
+        run_tests[cmd] = false if run_tests[cmd].nil?
+        run_tests[cmd]
+      end
+      allow(forced).to receive(:run) do |cmd = nil, **_opts, &block|
+        cmd = block.call([]) if block
+        commands << cmd
+      end
+      allow(forced).to receive(:invoke)
+      forced.send(:git_config)['remote -v'] = "production\tgit@example.com:/apps/demo (fetch)"
+      run_tests["[ -f /apps/demo/.git/hooks/post-receive ]"] = true
+      run_tests["test -x /apps/demo"] = true
+      run_tests["[ -d /apps/demo/.git ]"] = true
+
+      forced.setup
+
+      expect(commands).not_to be_empty
+    end
+
+    it 'skips git init when the remote repo already exists' do
+      run_tests["[ -d /apps/demo/.git ]"] = true
+
+      instance.setup
+
+      init_cmd = commands.flatten.join(' && ')
+      expect(init_cmd).not_to include('git init')
+      expect(init_cmd).to include('git config receive.denyCurrentBranch ignore')
+    end
+
     it 'initializes the remote repo with the current branch as HEAD' do
       instance.send(:git_config)['symbolic-ref -q HEAD'] = 'refs/heads/main'
 

data/spec/workflows_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'yaml'
+
+def load_workflow(path)
+  # Psych treats bare `on:` as boolean true; GitHub Actions uses it as the trigger key.
+  YAML.load(File.read(path).gsub(/^on:/, 'trigger:'))
+end
+
+describe 'GitHub workflows' do
+  let(:ci) { load_workflow('.github/workflows/ci.yml') }
+  let(:release) { load_workflow('.github/workflows/release.yml') }
+
+  it 'verifies the gem builds on every CI run' do
+    expect(ci['jobs']).to have_key('build-gem')
+  end
+
+  it 'publishes to RubyGems when a version tag is pushed' do
+    expect(release['trigger']['push']['tags']).to include('v*')
+    expect(release['jobs']).to have_key('release')
+  end
+
+  it 'runs the test suite before publishing' do
+    steps = release.dig('jobs', 'release', 'steps').map { |s| s['run'] }.compact
+    expect(steps).to include('bundle exec rspec')
+  end
+
+  it 'publishes to RubyGems with the API key secret' do
+    steps = release.dig('jobs', 'release', 'steps')
+    publish = steps.find { |s| s['name'] == 'Build and publish to RubyGems' }
+    expect(publish).not_to be_nil
+    expect(publish['run']).to include('gem push')
+    expect(publish['env']).to include('GEM_HOST_API_KEY')
+  end
+
+  it 'builds the gem on the latest supported Ruby' do
+    ruby = ci.dig('jobs', 'build-gem', 'steps').
+      find { |s| s['uses'] == 'ruby/setup-ruby@v1' }['with']['ruby-version']
+    expect(ruby).to eq('4.0')
+  end
+
+  it 'verifies the release tag matches the gemspec version' do
+    steps = release.dig('jobs', 'release', 'steps').map { |s| s['name'] }
+    expect(steps).to include('Verify tag matches gemspec version')
+  end
+
+  it 'verifies the changelog documents the release' do
+    steps = release.dig('jobs', 'release', 'steps').map { |s| s['name'] }
+    expect(steps).to include('Verify CHANGELOG documents this release')
+  end
+
+  it 'creates a GitHub release from the changelog section' do
+    steps = release.dig('jobs', 'release', 'steps')
+    gh_release = steps.find { |s| s['uses']&.start_with?('softprops/action-gh-release') }
+    expect(gh_release).not_to be_nil
+    expect(gh_release['with']['body_path']).to eq('release-notes.md')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-deploy-ng
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Nathan Edwards
@@ -71,31 +71,50 @@ description: A community continuation of mislav/git-deploy. Push-based, Heroku-l
 email: npfedwards@gmail.com
 executables:
 - git-deploy
+- update-changelog
 extensions: []
 extra_rdoc_files: []
 files:
+- AGENTS.md
+- CHANGELOG.md
 - CONTRIBUTING.md
 - LICENSE
 - MAINTAINERS.md
-- README.markdown
+- README.md
 - ROADMAP.md
 - bin/git-deploy
+- bin/update-changelog
 - lib/git_deploy.rb
+- lib/git_deploy/changelog.rb
 - lib/git_deploy/configuration.rb
 - lib/git_deploy/generator.rb
+- lib/git_deploy/remote_path.rb
 - lib/git_deploy/ssh_methods.rb
-- lib/git_deploy/templates/after_push.sh
-- lib/git_deploy/templates/before_restart.rb
-- lib/git_deploy/templates/restart.sh
+- lib/git_deploy/templates/generic/after_push.sh
+- lib/git_deploy/templates/generic/before_restart.sh
+- lib/git_deploy/templates/generic/restart.sh
+- lib/git_deploy/templates/php-composer/after_push.sh
+- lib/git_deploy/templates/php-composer/before_restart.sh
+- lib/git_deploy/templates/php-composer/restart.sh
+- lib/git_deploy/templates/rails-passenger/after_push.sh
+- lib/git_deploy/templates/rails-passenger/before_restart.rb
+- lib/git_deploy/templates/rails-passenger/restart.sh
+- lib/git_deploy/templates/rails-puma/after_push.sh
+- lib/git_deploy/templates/rails-puma/before_restart.rb
+- lib/git_deploy/templates/rails-puma/restart.sh
 - lib/hooks/post-receive.sh
+- spec/changelog_spec.rb
 - spec/cli_spec.rb
 - spec/commands_spec.rb
 - spec/configuration_spec.rb
+- spec/documentation_spec.rb
 - spec/generator_spec.rb
 - spec/hooks_spec.rb
+- spec/remote_path_spec.rb
 - spec/setup_spec.rb
 - spec/spec_helper.rb
 - spec/ssh_connection_spec.rb
+- spec/workflows_spec.rb
 homepage: https://github.com/npfedwards/git-deploy#readme
 licenses:
 - MIT
@@ -114,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Simple git push-based application deployment
 test_files: []

data/README.markdown

@@ -1,172 +0,0 @@
-Easy git deployment
-===================
-
-Community continuation of [mislav/git-deploy](https://github.com/mislav/git-deploy), published as **git-deploy-ng**. The CLI is unchanged: `git deploy <command>`.
-
-Straightforward, [Heroku][]-style, push-based deployment. Your deploys can become as simple as this:
-
-    $ git push production main
-
-To get started, install the gem on the machine that runs setup (once per project):
-
-    gem install git-deploy-ng
-
-Only the person who is setting up deployment for the first time needs to install
-the gem. You don't have to add it to your project's Gemfile. Production servers
-do not need Ruby — only bash and git.
-
-See [ROADMAP.md](ROADMAP.md) for ideas under consideration and [CONTRIBUTING.md](CONTRIBUTING.md) to contribute.
-
-
-Migrating from mislav/git-deploy
---------------------------------
-
-Requires **Ruby 2.7+** on the setup machine (including Ruby 4.x; system Ruby 2.6 on macOS is not supported).
-
-1. `gem uninstall git-deploy` (optional)
-2. `gem install git-deploy-ng`
-3. `git deploy hooks -r production` (optional, per host — refreshes remote hooks)
-
-Existing `deploy/` callback scripts in your apps do not need to change.
-
-
-Which app languages/frameworks are supported?
----------------------------------------------
-
-Regardless of the fact that this tool is mostly written in Ruby, git-deploy can be useful for any kind of code that needs deploying on a remote server. The default scripts are suited for Ruby web apps, but can be edited to accommodate other frameworks.
-
-Your deployment is customized with per-project callback scripts which can be written in any language.
-
-The assumption is that you're deploying to a single host to which you connect over SSH using public/private key authentication.
-
-
-Initial setup
--------------
-
-1.  Create a git remote for where you'll push the code on your server. The name of this remote in the examples is "production", but it can be whatever you wish ("online", "website", or other).
-
-    ```sh
-    git remote add production "user@example.com:/apps/mynewapp"
-    ```
-
-    `/apps/mynewapp` is the directory where you want your code to reside on the
-    remote server. If the directory doesn't exist, the next step creates it.
-
-2.  Run the setup task:
-
-    ```sh
-    git deploy setup -r "production"
-    ```
-
-    This will initialize the remote git repository in the deploy directory
-    (`/apps/mynewapp` in the above example) and install the remote git hook.
-
-3.  Run the init task:
-
-    ```sh
-    git deploy init
-    ```
-
-    This generates default deploy callback scripts in the `deploy/` directory.
-    You should check them in git because they are going to be executed on the
-    server during each deploy.
-
-4.  Push the code.
-
-    ```sh
-    git push production main
-    ```
-
-    Use whichever branch is checked out locally; `git deploy setup` configures the remote repo to match your current branch (`main` or `master`).
-
-5.  Login to your server and manually perform necessary one-time administrative operations. This might include:
-    * set up the Apache/nginx virtual host for this application;
-    * check your `config/database.yml` and create the production database.
-
-
-Everyday deployments
---------------------
-
-If you've set your app correctly, visiting <http://example.com> in your browser
-should show it up and running.
-
-Now, subsequent deployments are done simply **by pushing to the branch that is
-currently checked out on the remote**:
-
-    git push production main
-
-Because the deployments are performed with git, nobody else on the team needs to
-install the git-deploy gem.
-
-On every deploy, the default `deploy/after_push` script performs the following:
-
-1. updates git submodules (if there are any);
-2. runs `bundle install --deployment` if there is a Gemfile;
-3. runs `rake db:migrate` if new migrations have been added;
-4. clears cached CSS/JS assets in "public/stylesheets" and "public/javascripts";
-5. restarts the web application.
-
-You can customize all this by editing generated scripts in the `deploy/`
-directory of your app.
-
-Deployments are logged to `log/deploy.log` in your application's directory.
-
-
-How it works
-------------
-
-The `git deploy setup` command installed a `post-receive` git hook in the remote
-repository. This is how your code on the server is kept up to date. This script
-checks out the latest version of your project from the current branch and
-runs the following callback scripts:
-
-* `deploy/setup` - on first push.
-* `deploy/after_push` - on subsequent pushes. It in turn executes:
-  * `deploy/before_restart`
-  * `deploy/restart`
-  * `deploy/after_restart`
-* `deploy/rollback` - executed for `git deploy rollback`.
-
-All of the callbacks are optional. These scripts are ordinary Unix executables.
-The ones which get generated for you by `git deploy init` are written in shell
-script and Ruby.
-
-
-Extra commands
---------------
-
-* `git deploy hooks` - Updates git hooks on the remote repository
-
-* `git deploy log [N=20]` - Shows last 20 lines of deploy log on the server
-
-* `git deploy rerun` - Re-runs the `deploy/after_push` callback as if a git push happened
-
-* `git deploy restart` - Runs the `deploy/restart` callback
-
-* `git deploy rollback` - Undo a deploy by checking out the previous revision,
-  runs `deploy/rollback` if exists instead of `deploy/after_push`
-
-* `git deploy upload <files>` - Copy local files to the remote app
-
-
-Troubleshooting
----------------
-
-### `unsupported key type ssh-ed25519`
-
-Modern OpenSSH keys (ed25519) require optional gems that net-ssh does not bundle:
-
-```sh
-gem install ed25519 bcrypt_pbkdf
-```
-
-git-deploy-ng will print this command if the gems are missing when connecting.
-
-### Still running upstream `git-deploy` 0.7.0?
-
-The original gem targets older Ruby and net-ssh versions. Migrate to `git-deploy-ng`
-on Ruby 2.7+ — see [Migrating from mislav/git-deploy](#migrating-from-mislavgit-deploy).
-
-
-
-  [heroku]: http://heroku.com/