codeinventory-github 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ccf93961c2ce1c0a53b5ea470e64426d3fc30c1
-  data.tar.gz: '09123ff0ab9a4ff219dd57d424098d3673cce6ce'
+  metadata.gz: d651e57af5487d45ca2a94a294744db0478b534d
+  data.tar.gz: 82a01ed9bcb7f32d1df81fb81c8178b14fcb0497
 SHA512:
-  metadata.gz: '086435f3b0ce892da1c03e27e0727d8875a572a7d9c689ee96ad74c9b55fb2f3d387ca6cc6421cac9123a331c079d9d9299a6871916c92a2bf103b221cb18f48'
-  data.tar.gz: 66b3e4340458fbb4929c18a1beff51780be13539cb4c566e1fc2aff593d30ee338e3d3b381b20f7a33b5909bff085037ebcf17f7370fd5b0ac733b6d51d40330
+  metadata.gz: 261895fe5b3fdd30ff84687caaa3734f3b45dd1aeea9eca98100a0a444aef323aaa0ceb77fcd1b0167a426a459df8cdae2abb814508cc0021fabb2010499e2ea
+  data.tar.gz: 3ad1c942e9bd523c1b73d5cf35b8059153eef3e97b88c62ecb8f64d3e14d549e03084a0bd74987347e0b7c41f147829458afac95edb560eff433c4c32ee45f53

data/README.md

@@ -138,6 +138,20 @@ github_source = CodeInventory::GitHub::Source.new({ access_token: "GITHUB_ACCESS
 
 In this example, `codeinventory-github` will set the tags on all your projects to `my-tag-1` and `my-tag-2` also use the contact email you specified on all projects.
 
+### Using GitHub metadata
+
+If the metadata file does not exist or does not contain a field, and there are no overrides, `codeinventory-github` will use GitHub metadata to populate the field. These fields can be automatically populated from GitHub metadata:
+
+* name - GitHub repository name
+* description - GitHub repository description
+* license - GitHub repository license
+* openSourceProject - `true` if the repository is public, `false` if it is private
+* tags - GitHub repository topics
+* contact > email - GitHub organization email address
+* repository - GitHub repository URL
+
+If you already specify any of the above items in your GitHub repository, there is no need to specify them in a metadata file.
+
 ### Excluding repositories
 
 You can exclude any repository from scanning.

data/codeinventory-github.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock", "~> 2.1"
   spec.add_development_dependency "pry", "~> 0.10"
 
-  spec.add_runtime_dependency "codeinventory", "~> 0.2.0"
+  spec.add_runtime_dependency "codeinventory", "~> 0.3.0"
   spec.add_runtime_dependency "octokit", "~> 4.6"
 end

data/lib/codeinventory/github/version.rb

@@ -1,5 +1,5 @@
 module CodeInventory
   module GitHub
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeinventory-github
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Jeff Fredrickson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2017-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Harvests project metadata from YAML or JSON files in GitHub repositories.