wagemage 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f596f9720293dd85e8a9b05965efb4cd8e3d51f8abfd9670153c7b5d9df7c8b7
+  data.tar.gz: 97dc290c57992232e89451c160e0fce05d84efacefad48da94e3cc5a8bcdddb6
+SHA512:
+  metadata.gz: f208f9158b07a50220d32b98edfa36e66307a0bab44a0b508011e13aad1435458f39aa8aef2bd1a71db9bc17842921deb5710ec7bf45cbbd8c5443698db5f4c0
+  data.tar.gz: 9c32e145a8c1845bac31da49842224258376738b3d56cb872c12f0766d5177f6437e404a88e866530f40033b9a27e20e5cf2dbeac02a404c831de775e4609008

data/.github/workflows/tests.yml

@@ -0,0 +1,18 @@
+name: Tests
+on: [push]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Source Code
+        uses: actions/checkout@v1
+      - name: Install Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby_version: 2.6.x
+      - name: Install Dependencies
+        run: |
+          gem install bundler
+          bundle install
+      - name: Run Tests
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rubocop-http*

data/.rubocop.yml

@@ -0,0 +1,2 @@
+  inherit_from:
+    - https://raw.githubusercontent.com/workarea-commerce/workarea/master/.rubocop.yml

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.6
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at curt@portugly.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Specify your gem's dependencies in wagemage.gemspec
+gemspec
+
+gem 'pry', group: :development
+
+gem "vcr", "~> 5.0"
+
+gem "webmock", "~> 3.7"
+
+gem "activesupport", "~> 6.0"
+
+gem "mocha", "~> 1.11"

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    wagemage (1.0.0)
+      colorize (~> 0.8)
+      octokit (~> 4.14)
+      slop (~> 4.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.2)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    hashdiff (1.0.1)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    minitest (5.14.0)
+    mocha (1.11.2)
+    multipart-post (2.1.1)
+    octokit (4.19.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (4.0.3)
+    rake (12.3.3)
+    ruby2_keywords (0.0.2)
+    safe_yaml (1.0.5)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    slop (4.8.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    vcr (5.1.0)
+    webmock (3.8.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 6.0)
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  mocha (~> 1.11)
+  pry
+  rake (~> 12.3.3)
+  vcr (~> 5.0)
+  wagemage!
+  webmock (~> 3.7)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Curt Howard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,242 @@
+# Wagemage
+
+A CLI for making changes to many GitHub-hosted git repositories.
+
+[![Tests
+Status](https://github.com/meowsus/wagemage/workflows/Tests/badge.svg)](https://github.com/meowsus/wagemage/actions)
+
+## Inspiration
+
+At [Workarea](https://github.com/workarea-commerce) we have adopted a mutli-repo architecture for our platform and its plugins. Though separation is good, we have a lot of repositories. Sometimes we need to make changes across a great deal of our repositories. Sometimes we go a bit insane doing so.
+
+We tried using [Gitbot](https://github.com/clever/gitbot) but found that their solution only accounts for making changes to the default branch of each repository. This does not work for us, since we support many versions of our plugins and have therefore adopted a branching strategy that works for us.
+
+Wagemage was born out of fear of mundane tasks. Maybe it can help you too!
+
+## Installation
+
+```sh
+gem install wagemage
+```
+
+## Dependencies
+
+1. A [Github account](https://github.com/join)
+1. A [Github Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) with `repo` permissions
+1. [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+1. [Hub](https://github.com/github/hub/releases)
+1. One or more repositories owned by you or an organization of which you are a member
+
+## What It Does
+
+Wagemage hits the GitHub API to retrieve a list of repositories for the currently authenticated user. It can optionally be configured to search only within a given GitHub organization for this list of repositories.
+
+Once the list of repositories is derived, Wagemage asks if you'd like to clone the list of repos it has found. If you agree, they are cloned to a temporary directory on your machine that will be cleaned up once the operation is complete, unless otherwise specified.
+
+Upon cloning all of the repositories, each is searched for a list of remote branches. Wagemage can optionally be configured to search for remote branches that match a specific pattern.
+
+Once the list of branches is derived, Wagemage asks you to review the list of repositories and their branches to make sure that they look correct to you before executing the supplied script on each branch.
+
+For each branch in each repository the following occurs:
+1. The branch is checked out
+1. A new, "temporary" branch based on the branch that has been checked out is created in the format `[PREFIX]/[ORIGINAL_BRANCH_NAME]/[TIMESTAMP]`.
+1. The supplied script is executed and is passed arguments in this order:
+    1. The current repo's directory, and
+    1. The current repo's name, and
+    1. The current branch name
+1. **The following steps are skipped if**
+    * the script exits with a _non-zero exit code_
+    * the script exits with a _zero exit code_ but no changes were made to the repository
+1. All changes are added to the Git stage
+1. A commit is made, based on the `stdout` of the supplied script
+1. **The following steps are skipped if the `--debug` option is supplied**
+1. The branch is pushed
+1. A pull request is automatically created, with configurable reviewers
+
+## Usage
+
+```sh
+$ wagemage --help
+
+usage: wagemage [options]
+    -h, --help       print this help
+    -v, --version    print the version
+    -o, --org        github org
+    -r, --repo       regex against which to match repo names
+    -b, --branch     regex against which to match branches
+    -s, --script     the script to run on each repo's branch
+    --first-branch   operate only on the "oldest" branch
+    --reviewers      array of github users to put on the PR
+    --branch-prefix  prefix of the new branch
+    --debug          don't push or issue PR, keep the tmp directory
+```
+
+You will be prompted to enter your Github Personal Access Token at runtime, unless it is supplied as the value for the `WAGEMAGE_GITHUB_TOKEN` environment variable in your current session.
+
+### Options
+
+#### `--org` (or `-o`)
+
+Limits repository search to a specified GitHub organization.
+
+```
+--org workarea-commerce
+```
+
+* **Type**: String
+* **Required?**: No
+* **Default**: All repos available to the authenticated user
+
+#### `--repo` (or `-r`)
+
+Filter returned repositories based on name. Repository names are returned as full names: `meowsus/wagemage` instead of just `wagemage`.
+
+```
+--repo '^workarea-commerce/workarea-' # returns all Workarea plugin repos
+```
+
+* **Type**: Regex String
+* **Required?**: No
+* **Default**: None
+
+#### `--branch` (or `-b`)
+
+Filter available remote branches based on name.
+
+```
+--branch '(-stable$|^master$)' # returns all potentially stable branches
+```
+
+* **Type**: Regex String
+* **Required?**: No
+* **Default**: None
+
+#### `--script` (or `-s`)
+
+An path to a script to be executed on each derived branch across all derived repositories. This path can be absolute or relative to the directory in which the `wagemage` command is run.
+
+```
+--script ~/wagemage_scripts/hunt_the_wumpus
+--script /path/to/wagemage_scripts/angband
+--script ./wagemage_scripts/arena_of_octos
+--script scripts/dwarf_fortress
+```
+
+* **Type**: Path String
+* **Required?**: Yes
+* **Default**: None
+
+#### `--first-branch`
+
+A boolean option to indicate that only the first branch in the derived list of branches for a repository should be operated upon.
+
+```
+--branch '(-stable$|^master$)' \ # potentially returns `v2.1-stable, master`
+--first-branch # operates on `v2.1-stable` only
+```
+
+* **Type**: Boolean
+* **Required?**: No
+* **Default**: None
+
+#### `--reviewers`
+
+A comma-delineated list of GitHub users to add to the issued pull request. This list must not contain spaces.
+
+```
+--reviewers bencrouse,mttdffy,tubbo,jyucis,meowsus
+```
+
+* **Type**: Array
+* **Required?**: Yes
+* **Default**: None
+
+#### `--branch-prefix`
+
+The prefix of the "temporary" branch that is created before changes are made to the repository.
+
+```
+--branch-prefix WORKAREA-123
+```
+
+* **Type**: String
+* **Required?**: Yes
+* **Default**: `wagemage`
+
+#### `--help` (or `-h`)
+
+Displays the command's help and exits
+
+#### `--version` (or `-v`)
+
+Displays the command's version and exits
+
+#### `--debug`
+
+Prevents
+* pushing branches to GitHub
+* issuing pull requests
+* temporary directory cleanup
+
+### Examples
+
+All master branches across all repositories in a given organization:
+
+```sh
+wagemage \
+  --org workarea-commerce \
+  --branch '^master$' \
+  --script ~/path/to/some/script.sh
+```
+
+All master and development branches for a specific repository, and debug:
+
+```sh
+wagemage \
+  --repo 'meowsus/wagemage' \
+  --branch '^(master|develop)$' \
+  --script relative/to/current/directory/script.sh \
+  --debug
+```
+
+All stable release branches across the universe of Workarea and its plugins, prefixed with a Jira issue key to enable the Jira/GitHub integration, with all team members added to the pull request:
+
+```sh
+wagemage \
+  --org workarea-commerce \
+  --repo '^workarea-commerce/workarea' \
+  --branch '(-stable$|^master$)' \
+  --script ./hunt_the_wumpus \
+  --branch-prefix WORKAREA-123 \
+  --reviewers bencrouse,mttdffy,tubbo,jyucis
+```
+
+## Scripting
+
+As mentioned, the script is supplied with the current repository's path as the first argument, the current repository's name as the second, and the current branch name as the third.
+
+The script can be of any type that is executable by the host machine.
+
+The script **must** exit with a zero exit code to be considered successful. Exiting with a non-zero exit code tells Wagemage to skip operation on the current branch in the current repository.
+
+Peruse [the examples](./examples) for a better understanding of what to do and contribute your own if you've done something noteworthy!
+
+Any data sent to `STDERR` will be printed to your terminal after the command runs.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/meowsus/wagemage. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Wagemage project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/meowsus/wagemage/blob/master/CODE_OF_CONDUCT.md).