gitlab-branch-rename 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f33aa63fa0d74d53308136f89910a11d861daa231ba279f670188e4e832981f3
+  data.tar.gz: 8661fecb4807479d6df798baa2ea01f58173a6492dd3c8ffee60df42f953e9fd
+SHA512:
+  metadata.gz: 486bd423917b401e3d0a98485a621a0c3a3b7b63606721d1a1c47bf366014eb6e5b5b1079377633d5d91d824a97e985325ca89547c200b44d9f6b0006e628534
+  data.tar.gz: 220b75c80baa11007d68b7c3504438b7472ee937fac7b333225b0d51c570a6c067f3c7fcaab2caa0b9a43bebe4307a474ec35516b2d2653a2e4ecbbbac27fb74

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+gitlab-branch-rename-*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6@gitlab-branch-rename

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.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 ap@apfritts.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+ruby "~> 2.6"
+
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    gitlab-branch-rename (0.1.0)
+      gitlab (~> 4.16)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    gitlab (4.16.1)
+      httparty (~> 0.14, >= 0.14.0)
+      terminal-table (~> 1.5, >= 1.5.1)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gitlab-branch-rename!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+RUBY VERSION
+   ruby 2.7.0p0
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 AP Fritts
+
+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,44 @@
+# Gitlab::Branch::Rename
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gitlab/branch/rename`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gitlab-branch-rename'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gitlab-branch-rename
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/gitlab-branch-rename. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/gitlab-branch-rename/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 Gitlab::Branch::Rename project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gitlab-branch-rename/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rename"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/gitlab-branch-rename

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "rename"
+
+GitlabBranchRename.new.main

data/gitlab-branch-rename.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitlab-branch-rename"
+  spec.version       = GitlabBranchRename::VERSION
+  spec.authors       = ["AP Fritts"]
+  spec.email         = ["ap@apfritts.com"]
+
+  spec.summary       = 'Tool to rename your Gitlab project branches en-mass'
+  spec.description   = "To support Black Lives Matter and try to create safer spaces, I wanted to rename" +
+      "all of my own default branches in Gitlab. I wasn't able to find any tools to do that, so I wrote " +
+      "this one. If you're unsure why this is important or want to better understand my personal understanding" +
+      "of why I wanted to make these changes, see this Twitter thread: https://twitter.com/mislav/status/1270388510684598272"
+  spec.homepage      = "https://gitlab.com/apfritts/gitlab-branch-rename"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/apfritts/gitlab-branch-rename"
+
+  spec.add_runtime_dependency "gitlab", "~> 4.16"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/rename.rb

@@ -0,0 +1,9 @@
+require "version"
+
+module GitlabBranchRename
+  class Error < StandardError; end
+
+  def main
+    puts "hi"
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module GitlabBranchRename
+  VERSION = "0.1.0"
+end

data/rename.rb

@@ -0,0 +1,153 @@
+require "gitlab"
+
+ACCESS_LEVEL_MAINTAINER = 40
+
+puts("Create a Gitlab API key at https://gitlab.com/profile/personal_access_tokens")
+
+default_endpoint = "https://gitlab.com/api/v4"
+options = {
+    # Required parameters
+    endpoint: default_endpoint,
+    token: ENV["GITLAB_ACCESS_TOKEN"],
+    branch_to_rename: "master",
+    new_branch_name: "trunk",
+
+    # Criteria parameters with defaults
+    is_default_branch: true,
+    has_visibility: %w[private internal public],
+
+    # Optional parameters
+    confirm: true,
+    pretend: false,
+}
+
+logfile = "/tmp/gitlab-branch-rename.log"
+
+logger = Logger.new(STDOUT)
+logger.formatter = proc do |severity, datetime, progname, msg|
+  date_format = datetime.to_datetime.strftime("%Q")
+  if severity == "INFO" or severity == "WARN"
+    "#{severity}  #{date_format} #{msg}\n"
+  else
+    "#{severity} #{date_format} #{msg}\n"
+  end
+end
+
+Gitlab.endpoint = options[:endpoint]
+Gitlab.private_token = options[:token]
+
+#Gitlab.http_proxy("proxyhost", 8888)
+#Gitlab.http_proxy("proxyhost", 8888, "proxyuser", "strongpasswordhere")
+#ENV["GITLAB_API_HTTPARTY_OPTIONS"] = "{read_timeout: 60}"
+
+logger.info("Starting run with options: #{options}")
+
+# loop through all projects
+projects = Gitlab.projects(min_access_level: ACCESS_LEVEL_MAINTAINER,
+                           owned: true,
+                           per_page: 5)
+projects.auto_paginate do |project|
+  logger.info("Evaluating #{project.path_with_namespace}")
+  # Verify this project meets criteria for renaming
+  unless options[:has_visibility].include?(project.visibility)
+    logger.debug("Project has visibility #{project.visibility}, skipping")
+    next
+  end
+  if project.archived
+    logger.debug("Project is archived")
+    next
+  end
+  # Feature: Skip forks?
+  # Skip projects you don"t have proper permission to change
+  # Verify it meets your criteria for renaming default branch
+  if options[:is_default_branch] and project.default_branch != options[:branch_to_rename]
+    logger.debug("Project default branch does not match is_default_branch criteria")
+    next
+  end
+  # Feature: verify new branch doesn't already exist
+  begin
+    Gitlab.branch(project.id, options[:new_branch_name])
+    logger.debug("Destination branch #{options[:new_branch_name]} already exists")
+    next
+  rescue Gitlab::Error::NotFound => e
+    logger.debug("Destination branch #{options[:new_branch_name]} does not exist yet")
+  end
+  # Save branch protection parameters
+  old_branch = Gitlab.branch(project.id, options[:branch_to_rename])
+  branch_protection_parameters = nil
+  if old_branch.protected
+    # Save branch protection information
+    bpp_raw = Gitlab.protected_branch(project.id, old_branch.name)
+    bpp_hash = bpp_raw.to_hash
+    branch_protection_parameters = bpp_hash.slice("push_access_levels", "merge_access_levels", "unprotect_access_levels", "code_owner_approval_required")
+    logger.debug("Will transfer branch protection parameters: #{branch_protection_parameters}")
+  end
+  msg = "Rename #{project.path_with_namespace} branch #{options[:branch_to_rename]} to #{options[:new_branch_name]} " +
+      (branch_protection_parameters ? "with" : "without") + " protection"
+  if options[:pretend]
+    puts(msg)
+    logger.info(msg)
+    next
+  elsif options[:confirm]
+    puts(msg)
+    print("\tContinue with branch? (y/N) ")
+    input = gets.chomp
+    if input != "y"
+      msg = "Skipping branch rename for #{project.path_with_namespace} based on user input #{input}"
+      puts(msg)
+      logger.info(msg)
+      next
+    end
+    logger.info("User confirmed branch rename for #{project.path_with_namespace}")
+  end
+  # Create new branch
+  begin
+    new_branch = Gitlab.create_branch(project.id, options[:new_branch_name], old_branch.name)
+    logger.debug("Created new branch with name options[:new_branch_name]")
+  rescue StandardError => e
+    logger.error(e)
+    next
+  end
+  # Protect branch
+  unless branch_protection_parameters
+    begin
+      Gitlab.protect_branch(project.id, options[:new_branch_name], branch_protection_parameters)
+      logger.debug("Protected branch with parameters #{branch_protection_parameters}")
+    rescue StandardError => e
+      logger.error(e)
+    end
+  end
+  # Feature: Update PRs? Issues?
+  # Change default branch
+  begin
+    Gitlab.edit_project(project.id, {default_branch: options[:new_branch_name]})
+    logger.debug("Changed default branch")
+  rescue StandardError => e
+    logger.error(e)
+  end
+
+  # Unprotect protected branches
+  unless branch_protection_parameters
+    begin
+      Gitlab.unprotect_branch(project.id, old_branch.name)
+      logger.debug("Unprotected old branch")
+    rescue StandardError => e
+      logger.error(e)
+    end
+  end
+
+  # Delete master branch
+  begin
+    Gitlab.delete_branch(project.id, old_branch.name)
+    logger.debug("Deleted old branch")
+  rescue StandardError => e
+    logger.error(e)
+  end
+end
+
+puts "For any local repositories, use these commands to update:"
+puts "    git fetch `git remote` --prune"
+puts "    git checkout #{options[:new_branch_name]}"
+puts "    git remote set-head `git remote` #{options[:new_branch_name]}"
+puts "    git branch -d #{options[:branch_to_rename]}"
+logger.close

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-branch-rename
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AP Fritts
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.16'
+description: 'To support Black Lives Matter and try to create safer spaces, I wanted
+  to renameall of my own default branches in Gitlab. I wasn''t able to find any tools
+  to do that, so I wrote this one. If you''re unsure why this is important or want
+  to better understand my personal understandingof why I wanted to make these changes,
+  see this Twitter thread: https://twitter.com/mislav/status/1270388510684598272'
+email:
+- ap@apfritts.com
+executables:
+- gitlab-branch-rename
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gitlab-branch-rename
+- gitlab-branch-rename.gemspec
+- lib/rename.rb
+- lib/version.rb
+- rename.rb
+homepage: https://gitlab.com/apfritts/gitlab-branch-rename
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/apfritts/gitlab-branch-rename
+  source_code_uri: https://gitlab.com/apfritts/gitlab-branch-rename
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Tool to rename your Gitlab project branches en-mass
+test_files: []