travis_migrate_to_apps 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 54e04ebcc1b1588d8416207484abb238c5c71360
-  data.tar.gz: 7e17790cea3516724cfa8c74eb9b7ed05f60f857
+SHA256:
+  metadata.gz: 11aa9acdabfe9c4b3266ef1c1561efab04abd4ac06f89cb02931ebe29580cbb3
+  data.tar.gz: 21d585480351fbd6bc1e3745025e6aba13208d23a64e4f4bc32ca08f0499dfd2
 SHA512:
-  metadata.gz: cec556801f69ef27dfa8191801e015b8d8eb13ddcf9cecc7d7ba658607ec2993a120bf476be74661eda88f2526089d90588d2a3b53a77e5c78ad2ad117ddaa24
-  data.tar.gz: c02be5038224c58862e83415f0b519ff375166ae92e912e8521cecd5c0b2e7b819343463c7fbcbbbe50f810ef87ae119a96d7200745926239ad18f82026e7b4e
+  metadata.gz: 5ddb124d2978f0845f223287e6e7bf4a688179793371971a05aa134b918889ae8dddd41ee805b050236431705fdb71c283b24851646c3f05839692f7a1d2271b
+  data.tar.gz: 550a753c4c3f6c654923ca8fc5b0c994707b3dd4e884cfdfb141427fd387f4aa29aaf63047a9bc160e079ff82c7291cf52a4c211924df259ea06fab99da4a524

data/README.md

@@ -0,0 +1,74 @@
+# Migrate your GitHub organizations to use the Travis CI GitHub App integration
+
+This gem will help you migrate the repositories you have on [https://travis-ci.com](travis-ci.com) from legacy [GitHub Services](https://developer.github.com/v3/guides/replacing-github-services/) integration to the new [GitHub Apps](https://developer.github.com/apps/) integration.
+
+The main difference is that you will now give Travis CI access to your repositories on a repository basis instead of giving it access to all of them.
+
+Hence, we have developped this gem to help you migrate your repositories that are currently active on Travis CI in one sweep rather than having to add them manually one by one in the GitHub UI.
+
+Here are the steps:
+
+## 1. Install the gem
+```
+gem install travis_migrate_to_apps
+```
+
+## 2. Generate a GitHub personal access token with repo scope
+
+You can generate a new GitHub token [here](https://github.com/settings/tokens/new).
+
+Choose the name of your liking and ensure to select the whole `repo` scope as shown below:
+
+![GitHub new token page](https://github.com/travis-ci/travis_migrate_to_apps/blob/assets/github-token-new.png)
+
+Then click the "Generate token" button at the bottom to generate the token.
+
+You'll then be back on the GitHub token page:
+
+![GitHub token page](https://github.com/travis-ci/travis_migrate_to_apps/blob/assets/github-token-added.png)
+
+Take care of copying the newly generated token and save it for later usage.
+
+**Note: if you are migrating an organization, the token must be generated by [an owner of the GitHub organization](https://help.github.com/articles/permission-levels-for-an-organization/).**
+
+## 3. Activate the Travis CI GitHub Apps integration with 1 repo
+
+Go to your profile page on Travis CI: https://travis-ci.com/profile
+
+Click the "Activate GitHub Apps Integration" button highlighted below:
+
+![Activate GitHub Apps Integration button](https://github.com/travis-ci/travis_migrate_to_apps/blob/assets/github-apps-button-on-profile-page.png)
+
+You'll directed to the GitHub Apps page for the Travis CI app:
+
+![GitHub Apps page](https://github.com/travis-ci/travis_migrate_to_apps/blob/assets/travis-ci-github-app.png)
+
+Choose at least one repository and click the "Approve & Install" button.
+
+You'll then be redirected to your profile page on Travis CI and the newly added repository should appear under "GitHub Apps Integration":
+
+![Travis CI profile page](https://github.com/travis-ci/travis_migrate_to_apps/blob/assets/travis-ci-profile-with-github-apps-integration.png)
+
+## 4. Get your Travis CI API token
+
+Here are the two ways you can get this token:
+
+1. On your profile page: https://travis-ci.com/profile
+
+![Travis CI token on profile page](https://github.com/travis-ci/travis_migrate_to_apps/blob/assets/travis-ci-token-profile-page.png)
+
+2. Via the [Travis CI client](https://github.com/travis-ci/travis.rb) by running: `travis token --pro`
+
+## 5. Run the gem
+
+```
+travis_migrate_to_apps [owner_name] [travis_access_token] [github_access_token]
+```
+
+where 
+
+- `[owner_name]` is the GitHub account (user or organization) where the repositories you want to migrate are located
+- `[travis_access_token]` is the Travis CI token obtained in step #4 above
+- `[github_access_token]` is the GitHub token obtained in step #2 above
+
+Happy migration!

data/lib/travis_migrate_to_apps/cli.rb

@@ -3,10 +3,10 @@ require 'json'
 require 'colors'
 
 module TravisMigrateToApps
-  class Cli < Struct.new(:owner_name, :travis_access_token, :github_access_token)
+  class Cli < Struct.new(:owner_name, :travis_access_token, :github_access_token, :api_endpoint, :github_api_endpoint)
     include Colors
 
-    USAGE = 'Usage: travis_migrate_to_apps [owner_name] [travis_access_token] [github_access_token]'
+    USAGE = 'Usage: travis_migrate_to_apps [owner_name] [travis_access_token] [github_access_token] [travis api endpoint | https://api.travis-ci.com] [github api endpoint |  https://api.github.com]'
 
     MSGS = {
       start:                'Starting to migrate the account %s to use the Travis CI GitHub App integration.',
@@ -23,11 +23,11 @@ module TravisMigrateToApps
 
     URIS = {
       travis: {
-        installation: 'https://api.travis-ci.com/owner/%s?include=owner.installation',
-        repositories: 'https://api.travis-ci.com/owner/%s/repos?repository.active=true&repository.managed_by_installation=false&limit=%i&offset=%i'
+        installation: '%s/owner/%s?include=owner.installation',
+        repositories: '%s/owner/%s/repos?repository.active=true&repository.managed_by_installation=false&limit=%i&offset=%i'
       },
       github: {
-        installation_repos: 'https://api.github.com/user/installations/%i/repositories/%i'
+        installation_repos: '%s/user/installations/%i/repositories/%i'
       }
     }
 
@@ -46,11 +46,19 @@ module TravisMigrateToApps
     PER_PAGE = 20
 
     attr_reader :installation
+    attr_reader :api_endpoint
+    attr_reader :github_api_endpoint
 
     def initialize(*)
       super
       to_h.keys.each do |key|
-        missing_arg(key) unless send(key)
+        if key == :api_endpoint
+          @api_endpoint = to_h[key] ? to_h[key] :  'https://api.travis-ci.com'
+        elsif key == :github_api_endpoint
+          @github_api_endpoint = to_h[key] ? to_h[key] :  'https://api.github.com'
+        else
+          missing_arg(key) unless send(key)
+        end
       end
     end
 
@@ -86,21 +94,21 @@ module TravisMigrateToApps
 
       def migrate_repo(repo)
         msg :migrating_repo, repo['name'], nl: false
-        uri = uri(:github, :installation_repos, installation['github_id'], repo['github_id'])
+        uri = uri(:github, :installation_repos, github_api_endpoint, installation['github_id'], repo['github_id'])
         request(:put, uri, headers(:github))
         msg :migrated_repo, repo['name']
       end
 
       def fetch_installation
         msg :fetch_installation, owner_name
-        uri = uri(:travis, :installation, owner_name)
+        uri = uri(:travis, :installation, api_endpoint, owner_name)
         data = request(:get, uri, headers(:travis))
         data['installation']
       end
 
       def fetch_repos(repos = [], page = 1)
         offset = (page - 1) * PER_PAGE
-        uri    = uri(:travis, :repositories, owner_name, PER_PAGE, offset)
+        uri    = uri(:travis, :repositories, api_endpoint, owner_name, PER_PAGE, offset)
         data   = request(:get, uri, headers(:travis))
         repos += data['repositories'].map { |repo| only(repo, 'name', 'github_id') }
         repos  = fetch_repos(repos, page + 1) unless data['@pagination']['is_last']

data/lib/travis_migrate_to_apps/version.rb

@@ -1,3 +1,3 @@
 module TravisMigrateToApps
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: travis_migrate_to_apps
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Travis CI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-29 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies: []
 description: Migrate your GitHub organizations to use the Travis CI GitHub App integration.
 email:
@@ -19,8 +19,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- Gemfile.lock
 - LICENSE.md
+- README.md
 - bin/travis_migrate_to_apps
 - lib/colors.rb
 - lib/travis_migrate_to_apps.rb
@@ -45,8 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Migrate your GitHub organizations to use the Travis CI GitHub App integration

data/Gemfile.lock

@@ -1,44 +0,0 @@
-PATH
-  remote: .
-  specs:
-    travis_migrate_to_apps (0.0.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    hashdiff (0.3.7)
-    public_suffix (3.0.2)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    safe_yaml (1.0.4)
-    webmock (3.3.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rspec
-  travis_migrate_to_apps!
-  webmock
-
-BUNDLED WITH
-   1.16.1