From 87c4a04cec73473511567aa1f2911a9da6e77cf1 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Wed, 4 Sep 2019 00:04:38 -0400 Subject: [PATCH 1/2] workflows: add `apidoc` workflow for rubydoc.brew.sh --- .github/main.workflow | 10 ---------- .github/main.workflow.sh | 36 ---------------------------------- .github/workflows/apidoc.yml | 38 ++++++++++++++++++++++++++++++++++++ 3 files changed, 38 insertions(+), 46 deletions(-) delete mode 100644 .github/main.workflow delete mode 100755 .github/main.workflow.sh create mode 100644 .github/workflows/apidoc.yml diff --git a/.github/main.workflow b/.github/main.workflow deleted file mode 100644 index a5b7db742b5d9..0000000000000 --- a/.github/main.workflow +++ /dev/null @@ -1,10 +0,0 @@ -workflow "Push" { - on = "push" - resolves = ["Generate rubydoc.brew.sh"] -} - -action "Generate rubydoc.brew.sh" { - uses = "docker://ruby:latest" - runs = ".github/main.workflow.sh" - secrets = ["RUBYDOC_DEPLOY_KEY"] -} diff --git a/.github/main.workflow.sh b/.github/main.workflow.sh deleted file mode 100755 index 396b8bafd4134..0000000000000 --- a/.github/main.workflow.sh +++ /dev/null @@ -1,36 +0,0 @@ -#!/bin/bash - -set -e - -# silence bundler complaining about being root -mkdir ~/.bundle -echo 'BUNDLE_SILENCE_ROOT_WARNING: "1"' > ~/.bundle/config - -# configure git -git config --global user.name "BrewTestBot" -git config --global user.email "homebrew-test-bot@lists.sfconservancy.org" - -# setup SSH -mkdir ~/.ssh -chmod 700 ~/.ssh -echo "$RUBYDOC_DEPLOY_KEY" > ~/.ssh/id_ed25519 -chmod 600 ~/.ssh/id_ed25519 -git config --global core.sshCommand "ssh -i ~/.ssh/id_ed25519 -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no" - -# clone rubydoc.brew.sh with SSH so we can push back -git clone git@github.com:Homebrew/rubydoc.brew.sh -cd rubydoc.brew.sh - -# clone latest Homebrew/brew -git clone --depth=1 https://github.com/Homebrew/brew - -# run rake to build documentation -gem install bundler -bundle install -bundle exec rake - -# commit and push generated files -git add docs -git diff --exit-code HEAD -- docs && exit 0 -git commit -m 'docs: update from Homebrew/brew push' docs -git push diff --git a/.github/workflows/apidoc.yml b/.github/workflows/apidoc.yml new file mode 100644 index 0000000000000..5ec923140e19e --- /dev/null +++ b/.github/workflows/apidoc.yml @@ -0,0 +1,38 @@ +name: Generate rubydoc.brew.sh +on: + push: + branches: master +jobs: + apidoc: + runs-on: ubuntu-latest + steps: + - uses: docker://ruby:latest + - uses: Homebrew/actions/git-ssh@master + with: + git_user: BrewTestBot + git_email: homebrew-test-bot@lists.sfconservancy.org + key: ${{ secrets.RUBYDOC_DEPLOY_KEY }} + - run: | + # silence bundler complaining about being root + mkdir ~/.bundle + echo 'BUNDLE_SILENCE_ROOT_WARNING: "1"' > ~/.bundle/config + + # clone rubydoc.brew.sh with SSH so we can push back + git clone git@github.com:Homebrew/rubydoc.brew.sh + cd rubydoc.brew.sh + + # clone latest Homebrew/brew + git clone --depth=1 https://github.com/Homebrew/brew + + # run rake to build documentation + gem install bundler + bundle install + bundle exec rake + + # commit and push generated files + git add docs + + if ! git diff --exit-code HEAD -- docs; then + git commit -m 'docs: update from Homebrew/brew push' docs + git push + fi From 6f2b07163e1b6d73268ee963e12df3a2bd8e2146 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Wed, 4 Sep 2019 00:07:27 -0400 Subject: [PATCH 2/2] uses: move comment that was being read by yard --- Library/Homebrew/cmd/uses.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Library/Homebrew/cmd/uses.rb b/Library/Homebrew/cmd/uses.rb index 687bc03c623a0..1aa94714003fe 100644 --- a/Library/Homebrew/cmd/uses.rb +++ b/Library/Homebrew/cmd/uses.rb @@ -1,12 +1,12 @@ # frozen_string_literal: true -require "formula" -require "cli/parser" - # `brew uses foo bar` returns formulae that use both foo and bar # If you want the union, run the command twice and concatenate the results. # The intersection is harder to achieve with shell tools. +require "formula" +require "cli/parser" + module Homebrew module_function