From 850af0a0b6915e26ab660a9ee2bec3bb6b6e034e Mon Sep 17 00:00:00 2001 From: Mike Moore Date: Mon, 10 Sep 2018 09:55:33 -0600 Subject: [PATCH 1/8] Bump yard-doctest dependecy This new version ignores files excluded from .yardopts. This reduces the warnings for files YARD doesn't know how to document. --- Gemfile | 2 +- gcloud/gcloud.gemspec | 2 +- google-cloud-bigquery/google-cloud-bigquery.gemspec | 2 +- google-cloud-bigtable/google-cloud-bigtable.gemspec | 2 +- google-cloud-core/google-cloud-core.gemspec | 2 +- google-cloud-datastore/google-cloud-datastore.gemspec | 2 +- google-cloud-dns/google-cloud-dns.gemspec | 2 +- google-cloud-env/google-cloud-env.gemspec | 2 +- .../google-cloud-error_reporting.gemspec | 2 +- google-cloud-firestore/google-cloud-firestore.gemspec | 2 +- google-cloud-logging/google-cloud-logging.gemspec | 2 +- google-cloud-pubsub/google-cloud-pubsub.gemspec | 2 +- .../google-cloud-resource_manager.gemspec | 2 +- google-cloud-spanner/google-cloud-spanner.gemspec | 2 +- google-cloud-storage/google-cloud-storage.gemspec | 2 +- google-cloud-translate/google-cloud-translate.gemspec | 2 +- google-cloud-vision/google-cloud-vision.gemspec | 2 +- google-cloud/google-cloud.gemspec | 2 +- stackdriver-core/stackdriver-core.gemspec | 2 +- 19 files changed, 19 insertions(+), 19 deletions(-) diff --git a/Gemfile b/Gemfile index b113d7a2980d..26eda82a6570 100644 --- a/Gemfile +++ b/Gemfile @@ -11,7 +11,7 @@ gem "rubocop", "~> 0.50.0" gem "simplecov", "~> 0.9" gem "coveralls", "~> 0.7" gem "yard", "~> 0.9" -gem "yard-doctest", "<= 0.1.8" +gem "yard-doctest", "~> 0.1.13" gem "gems", "~> 0.8" gem "actionpack", "~> 4.0" gem "railties", "~> 4.0" diff --git a/gcloud/gcloud.gemspec b/gcloud/gcloud.gemspec index 4e36384d31d8..5f2607d8cf44 100644 --- a/gcloud/gcloud.gemspec +++ b/gcloud/gcloud.gemspec @@ -29,7 +29,7 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" gem.post_install_message = "gcloud is now google-cloud, please change the gem name in your dependencies" end diff --git a/google-cloud-bigquery/google-cloud-bigquery.gemspec b/google-cloud-bigquery/google-cloud-bigquery.gemspec index 4276c3036839..de50e5399b21 100644 --- a/google-cloud-bigquery/google-cloud-bigquery.gemspec +++ b/google-cloud-bigquery/google-cloud-bigquery.gemspec @@ -32,5 +32,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud-bigtable/google-cloud-bigtable.gemspec b/google-cloud-bigtable/google-cloud-bigtable.gemspec index 8f7b0cf53920..3bcb73089a7f 100644 --- a/google-cloud-bigtable/google-cloud-bigtable.gemspec +++ b/google-cloud-bigtable/google-cloud-bigtable.gemspec @@ -32,5 +32,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud-core/google-cloud-core.gemspec b/google-cloud-core/google-cloud-core.gemspec index 7f7e98f68258..b64249488adf 100644 --- a/google-cloud-core/google-cloud-core.gemspec +++ b/google-cloud-core/google-cloud-core.gemspec @@ -30,5 +30,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud-datastore/google-cloud-datastore.gemspec b/google-cloud-datastore/google-cloud-datastore.gemspec index c98637912860..9e0e8f087053 100644 --- a/google-cloud-datastore/google-cloud-datastore.gemspec +++ b/google-cloud-datastore/google-cloud-datastore.gemspec @@ -31,5 +31,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud-dns/google-cloud-dns.gemspec b/google-cloud-dns/google-cloud-dns.gemspec index ccc826ddbbce..030b0b1ea27c 100644 --- a/google-cloud-dns/google-cloud-dns.gemspec +++ b/google-cloud-dns/google-cloud-dns.gemspec @@ -32,5 +32,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud-env/google-cloud-env.gemspec b/google-cloud-env/google-cloud-env.gemspec index 6119078ee25c..4d443a0f583c 100644 --- a/google-cloud-env/google-cloud-env.gemspec +++ b/google-cloud-env/google-cloud-env.gemspec @@ -29,5 +29,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud-error_reporting/google-cloud-error_reporting.gemspec b/google-cloud-error_reporting/google-cloud-error_reporting.gemspec index f048f563b899..b5942b68b270 100644 --- a/google-cloud-error_reporting/google-cloud-error_reporting.gemspec +++ b/google-cloud-error_reporting/google-cloud-error_reporting.gemspec @@ -34,5 +34,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rack", ">= 0.1" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud-firestore/google-cloud-firestore.gemspec b/google-cloud-firestore/google-cloud-firestore.gemspec index 88b742c3dce9..cbe5d8e337b6 100644 --- a/google-cloud-firestore/google-cloud-firestore.gemspec +++ b/google-cloud-firestore/google-cloud-firestore.gemspec @@ -33,5 +33,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud-logging/google-cloud-logging.gemspec b/google-cloud-logging/google-cloud-logging.gemspec index 47516d60c57c..2b663098451c 100644 --- a/google-cloud-logging/google-cloud-logging.gemspec +++ b/google-cloud-logging/google-cloud-logging.gemspec @@ -32,7 +32,7 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" gem.add_development_dependency "railties", "~> 4.0" gem.add_development_dependency "rack", ">= 0.1" end diff --git a/google-cloud-pubsub/google-cloud-pubsub.gemspec b/google-cloud-pubsub/google-cloud-pubsub.gemspec index f48a92d02559..4659a9b3460c 100644 --- a/google-cloud-pubsub/google-cloud-pubsub.gemspec +++ b/google-cloud-pubsub/google-cloud-pubsub.gemspec @@ -32,5 +32,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud-resource_manager/google-cloud-resource_manager.gemspec b/google-cloud-resource_manager/google-cloud-resource_manager.gemspec index 13881db36c11..597b3f69cb7a 100644 --- a/google-cloud-resource_manager/google-cloud-resource_manager.gemspec +++ b/google-cloud-resource_manager/google-cloud-resource_manager.gemspec @@ -31,5 +31,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud-spanner/google-cloud-spanner.gemspec b/google-cloud-spanner/google-cloud-spanner.gemspec index 0a02ca7c68f8..647daf7f0843 100644 --- a/google-cloud-spanner/google-cloud-spanner.gemspec +++ b/google-cloud-spanner/google-cloud-spanner.gemspec @@ -31,5 +31,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud-storage/google-cloud-storage.gemspec b/google-cloud-storage/google-cloud-storage.gemspec index 81dd8ff03efc..73e9794f1e58 100644 --- a/google-cloud-storage/google-cloud-storage.gemspec +++ b/google-cloud-storage/google-cloud-storage.gemspec @@ -32,5 +32,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud-translate/google-cloud-translate.gemspec b/google-cloud-translate/google-cloud-translate.gemspec index dd1c6191f18c..123a22a8abf9 100644 --- a/google-cloud-translate/google-cloud-translate.gemspec +++ b/google-cloud-translate/google-cloud-translate.gemspec @@ -31,5 +31,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud-vision/google-cloud-vision.gemspec b/google-cloud-vision/google-cloud-vision.gemspec index 05fd213c7aa9..565f2b793293 100644 --- a/google-cloud-vision/google-cloud-vision.gemspec +++ b/google-cloud-vision/google-cloud-vision.gemspec @@ -30,5 +30,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end diff --git a/google-cloud/google-cloud.gemspec b/google-cloud/google-cloud.gemspec index 994c594bdbc4..0090edd9e7ca 100644 --- a/google-cloud/google-cloud.gemspec +++ b/google-cloud/google-cloud.gemspec @@ -55,7 +55,7 @@ Gem::Specification.new do |gem| gem.add_development_dependency "rubocop", "~> 0.50.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" gem.post_install_message = <<-POSTINSTALL ------------------------------ diff --git a/stackdriver-core/stackdriver-core.gemspec b/stackdriver-core/stackdriver-core.gemspec index d7ea36b5971c..ab33048daad7 100644 --- a/stackdriver-core/stackdriver-core.gemspec +++ b/stackdriver-core/stackdriver-core.gemspec @@ -29,5 +29,5 @@ Gem::Specification.new do |gem| gem.add_development_dependency "redcarpet", "~> 3.0" gem.add_development_dependency "simplecov", "~> 0.9" gem.add_development_dependency "yard", "~> 0.9" - gem.add_development_dependency "yard-doctest", "<= 0.1.8" + gem.add_development_dependency "yard-doctest", "~> 0.1.13" end From 141b789df8b146c362f5c3519d1b751ed26fcb4b Mon Sep 17 00:00:00 2001 From: Mike Moore Date: Mon, 10 Sep 2018 09:56:30 -0600 Subject: [PATCH 2/8] Update Datastore doctest helper The latest versions of yard-doctest have changed how context is determined. Move this helper so it will work with the latest version. --- google-cloud-bigquery/support/doctest_helper.rb | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/google-cloud-bigquery/support/doctest_helper.rb b/google-cloud-bigquery/support/doctest_helper.rb index c3516c6f87c1..3bbe362b8814 100644 --- a/google-cloud-bigquery/support/doctest_helper.rb +++ b/google-cloud-bigquery/support/doctest_helper.rb @@ -163,9 +163,6 @@ def mock_storage # Google::Cloud::Bigquery::Dataset#access@Manage the access rules by passing a block: doctest.before "Google::Cloud::Bigquery::Dataset#access" do mock_bigquery do |mock| - def other_dataset_view_object - "foo" - end mock.expect :insert_dataset, dataset_full_gapi, ["my-project", Google::Apis::BigqueryV2::Dataset] mock.expect :get_dataset, dataset_full_gapi, ["my-project", "my_dataset"] mock.expect :patch_dataset, dataset_full_gapi, ["my-project", "my_dataset", Google::Apis::BigqueryV2::Dataset, Hash] @@ -361,9 +358,6 @@ def other_dataset_view_object doctest.before "Google::Cloud::Bigquery::Dataset::Access" do mock_bigquery do |mock| - def other_dataset_view_object - "foo" - end mock.expect :insert_dataset, dataset_full_gapi, ["my-project", Google::Apis::BigqueryV2::Dataset] mock.expect :get_dataset, dataset_full_gapi, ["my-project", "my_dataset"] mock.expect :get_dataset, dataset_full_gapi, ["my-project", "my_other_dataset"] # for view methods @@ -1286,3 +1280,7 @@ def list_projects_gapi count = 2, token = nil def time_millis (Time.now.to_f * 1000).floor.to_s end + +def other_dataset_view_object + "foo" +end From df46e0868030f585a1b58b7c253fe57793dd94c5 Mon Sep 17 00:00:00 2001 From: Mike Moore Date: Mon, 10 Sep 2018 09:58:39 -0600 Subject: [PATCH 3/8] Fix doctest rake task The yard-doctest plugin isn't being loaded on CI. Ensure that plugins are loaded so doctest runs properly. --- google-cloud-bigquery/Rakefile | 4 ++-- google-cloud-datastore/Rakefile | 4 ++-- google-cloud-debugger/Rakefile | 4 ++-- google-cloud-dns/Rakefile | 4 ++-- google-cloud-error_reporting/Rakefile | 4 ++-- google-cloud-firestore/Rakefile | 4 ++-- google-cloud-logging/Rakefile | 4 ++-- google-cloud-pubsub/Rakefile | 4 ++-- google-cloud-resource_manager/Rakefile | 4 ++-- google-cloud-spanner/Rakefile | 2 +- google-cloud-storage/Rakefile | 4 ++-- google-cloud-trace/Rakefile | 2 +- google-cloud-translate/Rakefile | 4 ++-- google-cloud-vision/Rakefile | 4 ++-- 14 files changed, 26 insertions(+), 26 deletions(-) diff --git a/google-cloud-bigquery/Rakefile b/google-cloud-bigquery/Rakefile index 8af26b52c47b..dbf0bfc62f34 100644 --- a/google-cloud-bigquery/Rakefile +++ b/google-cloud-bigquery/Rakefile @@ -133,8 +133,8 @@ namespace :benchmark do end desc "Run yard-doctest example tests." -task doctest: :yard do - sh "bundle exec yard doctest" +task :doctest do + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end desc "Start an interactive shell." diff --git a/google-cloud-datastore/Rakefile b/google-cloud-datastore/Rakefile index 5390822f6d63..6077c7f533d1 100644 --- a/google-cloud-datastore/Rakefile +++ b/google-cloud-datastore/Rakefile @@ -80,8 +80,8 @@ namespace :acceptance do end desc "Run yard-doctest example tests." -task doctest: :yard do - sh "bundle exec yard doctest" +task :doctest do + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end desc "Start an interactive shell." diff --git a/google-cloud-debugger/Rakefile b/google-cloud-debugger/Rakefile index bf98ca9a6351..f459757ab2d4 100644 --- a/google-cloud-debugger/Rakefile +++ b/google-cloud-debugger/Rakefile @@ -130,8 +130,8 @@ namespace :integration do end desc "Run yard-doctest example tests." -task doctest: :yard do - sh "bundle exec yard doctest" +task :doctest do + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end desc "Start an interactive shell." diff --git a/google-cloud-dns/Rakefile b/google-cloud-dns/Rakefile index 9b2b14c00ad0..70f6b624761f 100644 --- a/google-cloud-dns/Rakefile +++ b/google-cloud-dns/Rakefile @@ -108,8 +108,8 @@ namespace :acceptance do end desc "Run yard-doctest example tests." -task doctest: :yard do - sh "bundle exec yard doctest" +task :doctest do + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end desc "Start an interactive shell." diff --git a/google-cloud-error_reporting/Rakefile b/google-cloud-error_reporting/Rakefile index b3b8f80f63ad..3bbf621fe3ab 100644 --- a/google-cloud-error_reporting/Rakefile +++ b/google-cloud-error_reporting/Rakefile @@ -84,8 +84,8 @@ namespace :acceptance do end desc "Run yard-doctest example tests." -task doctest: :yard do - sh "bundle exec yard doctest" +task :doctest do + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end namespace :integration do diff --git a/google-cloud-firestore/Rakefile b/google-cloud-firestore/Rakefile index 5fd0c8003b19..4f9e7a5ef641 100644 --- a/google-cloud-firestore/Rakefile +++ b/google-cloud-firestore/Rakefile @@ -157,8 +157,8 @@ require "yard/rake/yardoc_task" YARD::Rake::YardocTask.new desc "Run yard-doctest example tests." -task doctest: :yard do - sh "bundle exec yard doctest" +task :doctest do + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end desc "Run the CI build" diff --git a/google-cloud-logging/Rakefile b/google-cloud-logging/Rakefile index fb7bd4f1ffff..e6982bed806b 100644 --- a/google-cloud-logging/Rakefile +++ b/google-cloud-logging/Rakefile @@ -112,8 +112,8 @@ namespace :acceptance do end desc "Run yard-doctest example tests." -task doctest: :yard do - sh "bundle exec yard doctest" +task :doctest do + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end namespace :integration do diff --git a/google-cloud-pubsub/Rakefile b/google-cloud-pubsub/Rakefile index a882c52454bc..e478c6c1aa4c 100644 --- a/google-cloud-pubsub/Rakefile +++ b/google-cloud-pubsub/Rakefile @@ -106,9 +106,9 @@ namespace :acceptance do end desc "Run yard-doctest example tests." -#task doctest: :yard do +#task :doctest do task :doctest do - sh "bundle exec yard doctest" + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end desc "Start an interactive shell." diff --git a/google-cloud-resource_manager/Rakefile b/google-cloud-resource_manager/Rakefile index 362a960a76aa..e043db537fde 100644 --- a/google-cloud-resource_manager/Rakefile +++ b/google-cloud-resource_manager/Rakefile @@ -40,8 +40,8 @@ namespace :acceptance do end desc "Run yard-doctest example tests." -task doctest: :yard do - sh "bundle exec yard doctest" +task :doctest do + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end desc "Start an interactive shell." diff --git a/google-cloud-spanner/Rakefile b/google-cloud-spanner/Rakefile index bd1cdf5bece8..b3b23b79c673 100644 --- a/google-cloud-spanner/Rakefile +++ b/google-cloud-spanner/Rakefile @@ -114,7 +114,7 @@ end desc "Run yard-doctest example tests." task :doctest do - sh "bundle exec yard doctest" + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end desc "Start an interactive shell." diff --git a/google-cloud-storage/Rakefile b/google-cloud-storage/Rakefile index 58c28d4497b9..a04cc71aa56d 100644 --- a/google-cloud-storage/Rakefile +++ b/google-cloud-storage/Rakefile @@ -120,8 +120,8 @@ namespace :acceptance do end desc "Run yard-doctest example tests." -task doctest: :yard do - sh "bundle exec yard doctest" +task :doctest do + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end desc "Start an interactive shell." diff --git a/google-cloud-trace/Rakefile b/google-cloud-trace/Rakefile index f275b959196b..68d0e4033f53 100644 --- a/google-cloud-trace/Rakefile +++ b/google-cloud-trace/Rakefile @@ -114,7 +114,7 @@ end desc "Runs yard-doctest example tests." task :doctest do - sh "bundle exec yard doctest" + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end desc "Start an interactive shell." diff --git a/google-cloud-translate/Rakefile b/google-cloud-translate/Rakefile index 39c3429406d2..3336d0d7bac3 100644 --- a/google-cloud-translate/Rakefile +++ b/google-cloud-translate/Rakefile @@ -104,8 +104,8 @@ namespace :acceptance do end desc "Run yard-doctest example tests." -task doctest: :yard do - sh "bundle exec yard doctest" +task :doctest do + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end desc "Start an interactive shell." diff --git a/google-cloud-vision/Rakefile b/google-cloud-vision/Rakefile index 668937667a88..0b7655517c69 100644 --- a/google-cloud-vision/Rakefile +++ b/google-cloud-vision/Rakefile @@ -80,8 +80,8 @@ namespace :acceptance do end desc "Run yard-doctest example tests." -task doctest: :yard do - sh "bundle exec yard doctest" +task :doctest do + sh "bundle exec yard config load_plugins true && bundle exec yard doctest" end desc "Start an interactive shell." From 8587b5bcd5f111d614608009cdb28037c0ad1a1b Mon Sep 17 00:00:00 2001 From: Mike Moore Date: Mon, 10 Sep 2018 10:33:42 -0600 Subject: [PATCH 4/8] Add YARD wanings to CI We should fail a build if generating documentation gives a warning. Not every gem can do this yet, as there are still unresolved warnings. --- google-cloud-bigquery/Rakefile | 6 +++++- google-cloud-bigtable/Rakefile | 7 ++++++- google-cloud-datastore/Rakefile | 7 ++++++- google-cloud-debugger/Rakefile | 6 +++++- google-cloud-dns/Rakefile | 6 +++++- google-cloud-error_reporting/Rakefile | 7 ++++++- google-cloud-firestore/Rakefile | 7 ++++++- google-cloud-logging/Rakefile | 7 ++++++- google-cloud-pubsub/Rakefile | 6 +++++- google-cloud-resource_manager/Rakefile | 6 +++++- google-cloud-spanner/Rakefile | 7 ++++++- google-cloud-storage/Rakefile | 6 +++++- google-cloud-trace/Rakefile | 6 +++++- google-cloud-translate/Rakefile | 6 +++++- google-cloud-vision/Rakefile | 6 +++++- 15 files changed, 81 insertions(+), 15 deletions(-) diff --git a/google-cloud-bigquery/Rakefile b/google-cloud-bigquery/Rakefile index dbf0bfc62f34..531dc035f8b7 100644 --- a/google-cloud-bigquery/Rakefile +++ b/google-cloud-bigquery/Rakefile @@ -154,13 +154,17 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-bigquery" header "google-cloud-bigquery rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-bigquery yard", "*" + sh "bundle exec rake yard" header "google-cloud-bigquery doctest", "*" sh "bundle exec rake doctest" header "google-cloud-bigquery test", "*" diff --git a/google-cloud-bigtable/Rakefile b/google-cloud-bigtable/Rakefile index c7f1b7d2fc9a..99053752cd99 100644 --- a/google-cloud-bigtable/Rakefile +++ b/google-cloud-bigtable/Rakefile @@ -146,7 +146,9 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + # y.options << "--fail-on-warning" +end desc "Run yard-doctest example tests." task :doctest do @@ -158,6 +160,9 @@ task :ci do header "BUILDING google-cloud-bigtable" header "google-cloud-bigtable rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-bigtable yard", "*" + header "bigtable yard still had warnings", "!" + sh "bundle exec rake yard" header "google-cloud-bigtable doctest", "*" sh "bundle exec rake doctest" header "google-cloud-bigtable test", "*" diff --git a/google-cloud-datastore/Rakefile b/google-cloud-datastore/Rakefile index 6077c7f533d1..e888e89d550f 100644 --- a/google-cloud-datastore/Rakefile +++ b/google-cloud-datastore/Rakefile @@ -101,13 +101,18 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + # y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-datastore" header "google-cloud-datastore rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-datastore yard", "*" + header "datastore yard still had warnings", "!" + sh "bundle exec rake yard" header "google-cloud-datastore doctest", "*" sh "bundle exec rake doctest" header "google-cloud-datastore test", "*" diff --git a/google-cloud-debugger/Rakefile b/google-cloud-debugger/Rakefile index f459757ab2d4..0e3f1a69c18f 100644 --- a/google-cloud-debugger/Rakefile +++ b/google-cloud-debugger/Rakefile @@ -151,13 +151,17 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-debugger" header "google-cloud-debugger rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-debugger yard", "*" + sh "bundle exec rake yard" header "google-cloud-debugger doctest", "*" sh "bundle exec rake doctest" header "google-cloud-debugger test", "*" diff --git a/google-cloud-dns/Rakefile b/google-cloud-dns/Rakefile index 70f6b624761f..000610cde825 100644 --- a/google-cloud-dns/Rakefile +++ b/google-cloud-dns/Rakefile @@ -129,13 +129,17 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-dns" header "google-cloud-dns rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-dns yard", "*" + sh "bundle exec rake yard" header "google-cloud-dns doctest", "*" sh "bundle exec rake doctest" header "google-cloud-dns test", "*" diff --git a/google-cloud-error_reporting/Rakefile b/google-cloud-error_reporting/Rakefile index 3bbf621fe3ab..94d628ca635d 100644 --- a/google-cloud-error_reporting/Rakefile +++ b/google-cloud-error_reporting/Rakefile @@ -131,13 +131,18 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + # y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-error_reporting" header "google-cloud-error_reporting rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-error_reporting yard", "*" + header "error_reporting yard still had warnings", "!" + sh "bundle exec rake yard" header "google-cloud-error_reporting doctest", "*" sh "bundle exec rake doctest" header "google-cloud-error_reporting test", "*" diff --git a/google-cloud-firestore/Rakefile b/google-cloud-firestore/Rakefile index 4f9e7a5ef641..770bf740f48b 100644 --- a/google-cloud-firestore/Rakefile +++ b/google-cloud-firestore/Rakefile @@ -154,7 +154,9 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + # y.options << "--fail-on-warning" +end desc "Run yard-doctest example tests." task :doctest do @@ -166,6 +168,9 @@ task :ci do header "BUILDING google-cloud-firestore" header "google-cloud-firestore rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-firestore yard", "*" + header "firestore yard still had warnings", "!" + sh "bundle exec rake yard" header "google-cloud-firestore doctest", "*" sh "bundle exec rake doctest" header "google-cloud-firestore test", "*" diff --git a/google-cloud-logging/Rakefile b/google-cloud-logging/Rakefile index e6982bed806b..1812391ba02a 100644 --- a/google-cloud-logging/Rakefile +++ b/google-cloud-logging/Rakefile @@ -159,13 +159,18 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + # y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-logging" header "google-cloud-logging rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-logging yard", "*" + header "logging yard still had warnings", "!" + sh "bundle exec rake yard" header "google-cloud-logging doctest", "*" sh "bundle exec rake doctest" header "google-cloud-logging test", "*" diff --git a/google-cloud-pubsub/Rakefile b/google-cloud-pubsub/Rakefile index e478c6c1aa4c..e10fcea871bf 100644 --- a/google-cloud-pubsub/Rakefile +++ b/google-cloud-pubsub/Rakefile @@ -128,13 +128,17 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-pubsub" header "google-cloud-pubsub rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-pubsub yard", "*" + sh "bundle exec rake yard" header "google-cloud-pubsub doctest", "*" sh "bundle exec rake doctest" header "google-cloud-pubsub test", "*" diff --git a/google-cloud-resource_manager/Rakefile b/google-cloud-resource_manager/Rakefile index e043db537fde..80f815f88b94 100644 --- a/google-cloud-resource_manager/Rakefile +++ b/google-cloud-resource_manager/Rakefile @@ -61,13 +61,17 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-resource_manager" header "google-cloud-resource_manager rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-resource_manager yard", "*" + sh "bundle exec rake yard" header "google-cloud-resource_manager doctest", "*" sh "bundle exec rake doctest" header "google-cloud-resource_manager test", "*" diff --git a/google-cloud-spanner/Rakefile b/google-cloud-spanner/Rakefile index b3b23b79c673..8416139ac718 100644 --- a/google-cloud-spanner/Rakefile +++ b/google-cloud-spanner/Rakefile @@ -134,13 +134,18 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + # y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-spanner" header "google-cloud-spanner rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-spanner yard", "*" + header "spanner yard still had warnings", "!" + sh "bundle exec rake yard" header "google-cloud-spanner doctest", "*" sh "bundle exec rake doctest" header "google-cloud-spanner test", "*" diff --git a/google-cloud-storage/Rakefile b/google-cloud-storage/Rakefile index a04cc71aa56d..30502a9d8d7a 100644 --- a/google-cloud-storage/Rakefile +++ b/google-cloud-storage/Rakefile @@ -141,13 +141,17 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-storage" header "google-cloud-storage rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-storage yard", "*" + sh "bundle exec rake yard" header "google-cloud-storage doctest", "*" sh "bundle exec rake doctest" header "google-cloud-storage test", "*" diff --git a/google-cloud-trace/Rakefile b/google-cloud-trace/Rakefile index 68d0e4033f53..781a4289a677 100644 --- a/google-cloud-trace/Rakefile +++ b/google-cloud-trace/Rakefile @@ -134,13 +134,17 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-trace" header "google-cloud-trace rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-trace yard", "*" + sh "bundle exec rake yard" header "google-cloud-trace doctest", "*" sh "bundle exec rake doctest" header "google-cloud-trace test", "*" diff --git a/google-cloud-translate/Rakefile b/google-cloud-translate/Rakefile index 3336d0d7bac3..c7b71bef554a 100644 --- a/google-cloud-translate/Rakefile +++ b/google-cloud-translate/Rakefile @@ -125,13 +125,17 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-translate" header "google-cloud-translate rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-translate yard", "*" + sh "bundle exec rake yard" header "google-cloud-translate doctest", "*" sh "bundle exec rake doctest" header "google-cloud-translate test", "*" diff --git a/google-cloud-vision/Rakefile b/google-cloud-vision/Rakefile index 0b7655517c69..ef9730c5b09c 100644 --- a/google-cloud-vision/Rakefile +++ b/google-cloud-vision/Rakefile @@ -101,13 +101,17 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-vision" header "google-cloud-vision rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-vision yard", "*" + sh "bundle exec rake yard" header "google-cloud-vision doctest", "*" sh "bundle exec rake doctest" header "google-cloud-vision test", "*" From 8372ae7f001aed93f19e0a25b8ebe01eac2ac144 Mon Sep 17 00:00:00 2001 From: Mike Moore Date: Mon, 10 Sep 2018 10:34:04 -0600 Subject: [PATCH 5/8] Fix some unresolved documentation warnings --- google-cloud-pubsub/OVERVIEW.md | 6 +- google-cloud-spanner/LICENSE | 201 ++++++++++++++++++++++++++++++++ google-cloud-trace/OVERVIEW.md | 2 +- 3 files changed, 204 insertions(+), 5 deletions(-) create mode 100644 google-cloud-spanner/LICENSE diff --git a/google-cloud-pubsub/OVERVIEW.md b/google-cloud-pubsub/OVERVIEW.md index 6fc19c5db09e..ec7bbf72435a 100644 --- a/google-cloud-pubsub/OVERVIEW.md +++ b/google-cloud-pubsub/OVERVIEW.md @@ -70,8 +70,7 @@ puts subscription.name ## Creating a Subscription A Subscription is created from a Topic. (See -{Google::Cloud::Pubsub::Topic#subscribe Topic#subscribe} and -{Google::Cloud::Pubsub::Project#subscribe Project#subscribe}) +{Google::Cloud::Pubsub::Topic#subscribe Topic#subscribe}) ```ruby require "google/cloud/pubsub" @@ -101,8 +100,7 @@ sub = topic.subscribe "my-topic-sub", Messages are published to a topic. Any message published to a topic without a subscription will be lost. Ensure the topic has a subscription before -publishing. (See {Google::Cloud::Pubsub::Topic#publish Topic#publish} and -{Google::Cloud::Pubsub::Project#publish Project#publish}) +publishing. (See {Google::Cloud::Pubsub::Topic#publish Topic#publish}) ```ruby require "google/cloud/pubsub" diff --git a/google-cloud-spanner/LICENSE b/google-cloud-spanner/LICENSE new file mode 100644 index 000000000000..a8ee855de2aa --- /dev/null +++ b/google-cloud-spanner/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/google-cloud-trace/OVERVIEW.md b/google-cloud-trace/OVERVIEW.md index 76a065f3ec30..08ddfadc0e00 100644 --- a/google-cloud-trace/OVERVIEW.md +++ b/google-cloud-trace/OVERVIEW.md @@ -112,7 +112,7 @@ Stackdriver Trace API. This API provides calls to report and modify application traces, as well as to query and analyze existing traces. For further information on the trace API, see -{Project}. +{Google::Cloud::Trace::Project}. ### Querying traces using the API From 641c3d879ad858841ba897d5988b1f8eba2571a3 Mon Sep 17 00:00:00 2001 From: Mike Moore Date: Mon, 10 Sep 2018 10:53:51 -0600 Subject: [PATCH 6/8] Mark Vision as having YARD warnings --- google-cloud-vision/Rakefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/google-cloud-vision/Rakefile b/google-cloud-vision/Rakefile index ef9730c5b09c..02b27f1477dd 100644 --- a/google-cloud-vision/Rakefile +++ b/google-cloud-vision/Rakefile @@ -102,7 +102,7 @@ end require "yard" require "yard/rake/yardoc_task" YARD::Rake::YardocTask.new do |y| - y.options << "--fail-on-warning" + # y.options << "--fail-on-warning" end desc "Run the CI build" @@ -111,6 +111,7 @@ task :ci do header "google-cloud-vision rubocop", "*" sh "bundle exec rake rubocop" header "google-cloud-vision yard", "*" + header "vision yard still had warnings", "!" sh "bundle exec rake yard" header "google-cloud-vision doctest", "*" sh "bundle exec rake doctest" From 48a69eaf736a848aee0860dd02c8ce65cf034c23 Mon Sep 17 00:00:00 2001 From: Mike Moore Date: Mon, 10 Sep 2018 11:05:00 -0600 Subject: [PATCH 7/8] Check for doc warnings on meta and core gems --- gcloud/Rakefile | 6 +++++- google-cloud-core/Rakefile | 6 +++++- google-cloud-env/Rakefile | 6 +++++- google-cloud/Rakefile | 6 +++++- stackdriver-core/Rakefile | 6 +++++- stackdriver/Rakefile | 6 +++++- 6 files changed, 30 insertions(+), 6 deletions(-) diff --git a/gcloud/Rakefile b/gcloud/Rakefile index c12e6a04af2e..61f7724f8230 100644 --- a/gcloud/Rakefile +++ b/gcloud/Rakefile @@ -61,13 +61,17 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING gcloud" header "gcloud rubocop", "*" sh "bundle exec rake rubocop" + header "gcloud yard", "*" + sh "bundle exec rake yard" header "gcloud doctest", "*" sh "bundle exec rake doctest" header "gcloud test", "*" diff --git a/google-cloud-core/Rakefile b/google-cloud-core/Rakefile index d8e0938fc865..ba852c0a455c 100644 --- a/google-cloud-core/Rakefile +++ b/google-cloud-core/Rakefile @@ -60,7 +60,9 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do @@ -68,6 +70,8 @@ task :ci do header "google-cloud-core rubocop", "*" sh "bundle exec rake rubocop" header "google-cloud-core doctest", "*" + sh "bundle exec rake yard" + header "google-cloud-core yard", "*" sh "bundle exec rake doctest" header "google-cloud-core test", "*" sh "bundle exec rake test" diff --git a/google-cloud-env/Rakefile b/google-cloud-env/Rakefile index 9f7e47403cbe..a39d002d5322 100644 --- a/google-cloud-env/Rakefile +++ b/google-cloud-env/Rakefile @@ -59,13 +59,17 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud-env" header "google-cloud-env rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud-env yard", "*" + sh "bundle exec rake yard" header "google-cloud-env doctest", "*" sh "bundle exec rake doctest" header "google-cloud-env test", "*" diff --git a/google-cloud/Rakefile b/google-cloud/Rakefile index 3264d36d0078..8d1686f9c9d3 100644 --- a/google-cloud/Rakefile +++ b/google-cloud/Rakefile @@ -61,13 +61,17 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING google-cloud" header "google-cloud rubocop", "*" sh "bundle exec rake rubocop" + header "google-cloud yard", "*" + sh "bundle exec rake yard" header "google-cloud doctest", "*" sh "bundle exec rake doctest" header "google-cloud test", "*" diff --git a/stackdriver-core/Rakefile b/stackdriver-core/Rakefile index 413054b13114..6d0fe72a5391 100644 --- a/stackdriver-core/Rakefile +++ b/stackdriver-core/Rakefile @@ -60,13 +60,17 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do header "BUILDING stackdriver-core" header "stackdriver-core rubocop", "*" sh "bundle exec rake rubocop" + header "stackdriver-core yard", "*" + sh "bundle exec rake yard" header "stackdriver-core doctest", "*" sh "bundle exec rake doctest" header "stackdriver-core test", "*" diff --git a/stackdriver/Rakefile b/stackdriver/Rakefile index aa5a814e5609..d4ff62446823 100644 --- a/stackdriver/Rakefile +++ b/stackdriver/Rakefile @@ -79,7 +79,9 @@ end require "yard" require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end desc "Run the CI build" task :ci do @@ -87,6 +89,8 @@ task :ci do sh "bundle exec rake debugger_c" header "stackdriver rubocop", "*" sh "bundle exec rake rubocop" + header "stackdriver yard", "*" + sh "bundle exec rake yard" header "stackdriver doctest", "*" sh "bundle exec rake doctest" header "stackdriver test", "*" From 926597f39529643e5302a4aeef724f24df8c3417 Mon Sep 17 00:00:00 2001 From: Mike Moore Date: Mon, 10 Sep 2018 11:11:57 -0600 Subject: [PATCH 8/8] Add compile as dependency to Debugger ci task --- google-cloud-debugger/Rakefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/google-cloud-debugger/Rakefile b/google-cloud-debugger/Rakefile index 0e3f1a69c18f..c7ad51bbe130 100644 --- a/google-cloud-debugger/Rakefile +++ b/google-cloud-debugger/Rakefile @@ -30,7 +30,7 @@ task :recompile do end desc "Run tests." -task :test => :compile do +task test: :compile do $LOAD_PATH.unshift "lib", "test" Dir.glob("test/**/*_test.rb").each { |file| require_relative file } end @@ -156,7 +156,7 @@ YARD::Rake::YardocTask.new do |y| end desc "Run the CI build" -task :ci do +task ci: :compile do header "BUILDING google-cloud-debugger" header "google-cloud-debugger rubocop", "*" sh "bundle exec rake rubocop"