toys-release 0.1.1 → 0.2.2

data/toys/_onclosed.rb

@@ -88,7 +88,7 @@ def handle_release_merged
     @utils.error("GitHub checks failed", *github_check_errors)
   end
   performer = create_performer
-  performer.perform_pr_releases
+  performer.perform_pr_releases unless performer.error?
   performer.report_results
   if performer.error?
     @utils.error("Releases reported failure")

data/toys/perform.rb

@@ -106,11 +106,13 @@ def run
 
   setup_arguments
   setup_performer
-  components.each do |component_spec|
-    name, version = component_spec.split(/[:=]/, 2)
-    confirmation_ui(name, version)
-    gem_version = version ? ::Gem::Version.new(version) : nil
-    @performer.perform_adhoc_release(name, assert_version: gem_version)
+  unless @performer.error?
+    components.each do |component_spec|
+      name, version = component_spec.split(/[:=]/, 2)
+      confirmation_ui(name, version)
+      gem_version = version ? ::Gem::Version.new(version) : nil
+      @performer.perform_adhoc_release(name, assert_version: gem_version)
+    end
   end
   puts @performer.build_report_text
 end

data/toys/retry.rb

@@ -18,12 +18,13 @@ flag_group desc: "Flags" do
       "Run in dry-run mode, where checks are made and releases are built" \
       " but are not pushed."
   end
-  flag :gh_pages_dir, "--gh-pages-dir=VAL" do
-    desc "The directory to use for the gh-pages branch"
+  flag :work_dir, "--work-dir=VAL" do
+    desc "The directory to use for artifacts and temporary files"
     long_desc \
-      "Set to the path of a directory to use as the gh-pages workspace when" \
-      " building and pushing gem documentation. If left unset, a temporary" \
-      " directory will be created (and removed when finished)."
+      "If provided, the given directory path is used for artifacts and" \
+        " temporary files, and is left intact after the release so the" \
+        " artifacts can be inspected. If omitted, a new temporary directory" \
+        " is created, and is automatically deleted after the release."
   end
   flag :git_remote, "--git-remote=VAL" do
     default "origin"
@@ -84,13 +85,13 @@ def setup_objects
   @repo_settings = Toys::Release::RepoSettings.load_from_environment(@utils)
   @repository = Toys::Release::Repository.new(@utils, @repo_settings)
   @repository.git_set_user_info
+  @pull_request = @repository.load_pr(release_pr)
 end
 
 def verify_release_pr
-  @pr_info = @repository.load_pr(release_pr)
-  @utils.error("Could not load pull request ##{release_pr}") unless @pr_info
+  @utils.error("Could not load pull request ##{release_pr}") unless @pull_request
   expected_labels = [@repo_settings.release_pending_label, @repo_settings.release_error_label]
-  return if @pr_info["labels"].any? { |label| expected_labels.include?(label["name"]) }
+  return if @pull_request.labels.any? { |label| expected_labels.include?(label) }
   warning = "PR #{release_pr} doesn't have the release pending or release error label."
   if yes
     logger.warn(warning)
@@ -102,12 +103,17 @@ def verify_release_pr
 end
 
 def setup_params
-  [:gh_pages_dir, :rubygems_api_key].each do |key|
+  [
+    :git_remote,
+    :release_ref,
+    :rubygems_api_key,
+    :work_dir,
+  ].each do |key|
     set(key, nil) if get(key).to_s.empty?
   end
-  ::ENV["GEM_HOST_API_KEY"] = rubygems_api_key if rubygems_api_key
   set(:dry_run, /^t/i.match?(::ENV["TOYS_RELEASE_DRY_RUN"].to_s)) if dry_run.nil?
-  set :release_ref, @repository.current_sha(release_ref || @pr_info["merge_commit_sha"])
+  ::ENV["GEM_HOST_API_KEY"] = rubygems_api_key if rubygems_api_key
+  set :release_ref, @repository.current_sha(release_ref || @pull_request.merge_commit_sha)
 end
 
 def create_performer
@@ -116,14 +122,14 @@ def create_performer
                                release_pr: release_pr,
                                enable_prechecks: enable_prechecks,
                                git_remote: git_remote,
-                               gh_pages_dir: gh_pages_dir,
+                               work_dir: work_dir,
                                dry_run: dry_run)
 end
 
 def perform_pending_releases
-  @repository.wait_github_checks(release_ref) if enable_prechecks
+  @repository.wait_github_checks(ref: release_ref) if enable_prechecks
   performer = create_performer
-  performer.perform_pr_releases
+  performer.perform_pr_releases unless performer.error?
   performer.report_results
   if performer.error?
     @utils.error("Releases reported failure")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: toys-release
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Daniel Azuma
@@ -48,7 +48,6 @@ files:
 - toys/.data/templates/gh-pages-gitignore.erb
 - toys/.data/templates/gh-pages-index.html.erb
 - toys/.data/templates/release-hook-on-closed.yml.erb
-- toys/.data/templates/release-hook-on-open.yml.erb
 - toys/.data/templates/release-hook-on-push.yml.erb
 - toys/.data/templates/release-perform.yml.erb
 - toys/.data/templates/release-request.yml.erb
@@ -59,6 +58,7 @@ files:
 - toys/.lib/toys/release/component.rb
 - toys/.lib/toys/release/environment_utils.rb
 - toys/.lib/toys/release/performer.rb
+- toys/.lib/toys/release/pipeline.rb
 - toys/.lib/toys/release/pull_request.rb
 - toys/.lib/toys/release/repo_settings.rb
 - toys/.lib/toys/release/repository.rb
@@ -69,7 +69,6 @@ files:
 - toys/.lib/toys/release/version_rb_file.rb
 - toys/.toys.rb
 - toys/_onclosed.rb
-- toys/_onopen.rb
 - toys/_onpush.rb
 - toys/create-labels.rb
 - toys/gen-gh-pages.rb
@@ -82,10 +81,10 @@ homepage: https://github.com/dazuma/toys
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://dazuma.github.io/toys/gems/toys-release/v0.1.1/file.CHANGELOG.html
+  changelog_uri: https://dazuma.github.io/toys/gems/toys-release/v0.2.2/file.CHANGELOG.html
   source_code_uri: https://github.com/dazuma/toys/tree/main/toys-release
   bug_tracker_uri: https://github.com/dazuma/toys/issues
-  documentation_uri: https://dazuma.github.io/toys/gems/toys-release/v0.1.1
+  documentation_uri: https://dazuma.github.io/toys/gems/toys-release/v0.2.2
 rdoc_options: []
 require_paths:
 - lib

data/toys/.data/templates/release-hook-on-open.yml.erb

@@ -1,30 +0,0 @@
-name: "[release hook] Check commit messages"
-
-on:
-  pull_request_target:
-    types: [opened, edited, synchronize, reopened]
-
-jobs:
-  release-check-commits:
-    if: ${{ github.repository == '<%= @settings.repo_path %>' }}
-    env:
-      ruby_version: "3.4"
-    runs-on: ubuntu-latest
-    steps:
-      - name: Install Ruby ${{ env.ruby_version }}
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ env.ruby_version }}
-      - name: Checkout repo
-        uses: actions/checkout@v5
-        with:
-          ref: refs/pull/${{ github.event.pull_request.number }}/merge
-      - name: Install Toys
-        run: "gem install --no-document toys"
-      - name: Check commit messages
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          toys release _onopen --verbose \
-            "--event-path=${{ github.event_path }}" \
-            < /dev/null

data/toys/_onopen.rb

@@ -1,158 +0,0 @@
-# frozen_string_literal: true
-
-desc "Check a pull request"
-
-long_desc \
-  "This tool is called by a GitHub Actions workflow when any pull request" \
-    " is opened or synchronized. It checks the commit messages and/or pull" \
-    " request title (as appropriate) for conventional commit style."
-
-flag :event_path, "--event-path=VAL" do
-  default ::ENV["GITHUB_EVENT_PATH"]
-  desc "Path to the pull request event JSON file"
-end
-
-include :exec
-include :terminal, styled: true
-
-def run
-  setup
-  lint_commit_messages if @utils.commit_lint_active?
-end
-
-def setup
-  ::Dir.chdir(context_directory)
-
-  require "json"
-  require "toys/release/environment_utils"
-  require "toys/release/pull_request"
-  require "toys/release/repo_settings"
-  require "toys/release/repository"
-
-  @utils = Toys::Release::EnvironmentUtils.new(self)
-  @settings = Toys::Release::RepoSettings.load_from_environment(@utils)
-  @repository = Toys::Release::Repository.new(@utils, @settings)
-
-  @utils.error("GitHub event path missing") unless event_path
-  pr_resource = ::JSON.parse(::File.read(event_path))["pull_request"]
-  @pull_request = Toys::Release::PullRequest.new(@repository, pr_resource)
-end
-
-def lint_commit_messages
-  errors = []
-  shas = find_shas
-  if shas.size == 1 || !@settings.commit_lint_merge.intersection(["merge", "rebase"]).empty?
-    lint_sha_messages(shas, errors)
-  end
-  if shas.size > 1 && @settings.commit_lint_merge.include?("squash")
-    lint_pr_message(errors)
-  end
-  if errors.empty?
-    puts "No conventional commit format problems found.", :green, :bold
-  else
-    report_lint_errors(errors)
-    if @settings.commit_lint_fail_checks?
-      @utils.error("Failing due to conventional commit format problems")
-    end
-  end
-end
-
-def find_shas
-  @repository.git_unshallow("origin", branch: @pull_request.head_sha)
-  log = capture(["git", "log", "#{@pull_request.base_sha}..#{@pull_request.head_sha}", "--format=%H"], e: true)
-  shas = log.split("\n").reverse
-  shas.find_all do |sha|
-    parents = capture(["git", "show", "-s", "--pretty=%p", sha], e: true).strip.split
-    @utils.log("Omitting merge commit #{sha}") if parents.size > 1
-    parents.size == 1
-  end
-end
-
-def lint_sha_messages(shas, errors)
-  shas.each do |sha|
-    @utils.log("Checking commit #{sha} ...")
-    message = capture(["git", "log", "#{sha}^..#{sha}", "--format=%B"], e: true).strip
-    lint_message(message) do |err|
-      @utils.warning("Commit #{sha}: #{err}")
-      suggestion = "Please consider amending the commit message."
-      if @settings.commit_lint_merge == ["squash"]
-        suggestion += " Alternately, because this pull request will be squashed when merged, you" \
-                      " can add multiple commits, and instead make sure the pull request _title_" \
-                      " conforms to the Conventional Commit format."
-      end
-      err =
-        [
-          "The message for commit #{sha} does not conform to the Conventional Commit format.",
-          "",
-          "```",
-        ] + message.split("\n") + [
-          "```",
-          "",
-          err,
-          suggestion,
-        ]
-      errors << err
-    end
-  end
-end
-
-def lint_pr_message(errors)
-  @utils.log("Checking Pull request title ...")
-  lint_message(@pull_request.title) do |err|
-    @utils.warning("PR title: #{err}")
-    header = "The pull request title does not conform to the Conventional Commit format."
-    header +=
-      if @settings.commit_lint_merge == ["squash"]
-        " (The title will be used as the merge commit message when this pull request is merged.)"
-      else
-        " (The title may be used as the merge commit message if this pull request is squashed" \
-          " when merged.)"
-      end
-    errors << [
-      header,
-      "",
-      "```",
-      @pull_request.title,
-      "```",
-      "",
-      err,
-    ]
-  end
-end
-
-def lint_message(message)
-  lines = message.split("\n")
-  matches = /^([\w-]+)(?:\(([^()]+)\))?!?:\s(.+)$/.match(lines.first)
-  unless matches
-    yield "The first line should follow the form `<type>: <description>`."
-    return
-  end
-  allowed_types = @settings.commit_lint_allowed_types
-  if allowed_types && !allowed_types.include?(matches[1].downcase)
-    yield "The type `#{matches[1]}` is not allowed by this repository." \
-          " Please use one of the types: `#{allowed_types.inspect}`."
-  end
-  if lines.size > 1 && !lines[1].empty?
-    yield "You may not use multiple conventional commit formatted lines." \
-          " If you want to include a body or footers in your commit message," \
-          " they must be separated from the main message by a blank line." \
-          " If you are making multiple semantic changes, please use separate" \
-          " commits/pull requets."
-  end
-end
-
-def report_lint_errors(errors)
-  header = <<~STR
-    Please use [Conventional Commit](https://conventionalcommits.org/) format \
-    for commit messages and pull request titles. The automated linter found \
-    the following problems in this pull request:
-  STR
-  lines = [header]
-  errors.each do |error_lines|
-    lines << "" << " *  #{error_lines.first}"
-    error_lines[1..].each do |err_line|
-      lines << (err_line.empty? ? "" : "    #{err_line}")
-    end
-  end
-  @pull_request.add_comment(lines.join("\n"))
-end