metanorma-release 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e4ed312d1cdaa5cea2092166d82834a5fa85a05fb8a42b30f43ea215f773bd4
-  data.tar.gz: 366a9d6138af1dee33f67608d635e7f665388057bd82363257f35bcdd2f85b32
+  metadata.gz: 7f35e60b63c59a16ffc5b88d2109cb307e0fa92516da21eddc5440bf6ad92196
+  data.tar.gz: c9477fa6090bf5afa89d74329cab173895add611476dc0ca7868d474280cda33
 SHA512:
-  metadata.gz: 660c462528a52631d92bcac5e3b1a20dac9782a3a2732ea1df8aecc237c89332eaa0900b9648bec7f2d244d3dcf968ee76e598723d464ff530784c41ca3fa839
-  data.tar.gz: 23e08bd704747c50e34af4ba468aaca22b8dfe965140fe811d7afd3867bfecb4a60d7bf0d7945d30f5a47bc5ab3bbf35aa3cc092ee7762bceabe20737f08e115
+  metadata.gz: 3e43d168fa1438c85ce2886b238efabaea9be5e3dc4c18eb3e5e584390a5151d54a0ea86de30d32ad0d838ed3e0353cb2b61bd5a3111f1db982af621f707dc78
+  data.tar.gz: b23d8f3364286e1abb805e2745f7b3d45e6cdb079b41fe22e66f11a72b997bc9081c6bee6b74bf0ebdd714f018da8ab5e345a67bcac6a0f1bb5680489aaa5dd5

data/README.adoc

@@ -45,13 +45,13 @@ The gem ships three commands:
 [source,sh]
 ----
 # Package compiled documents as zip archives
-mn-release package --output-dir _site --manifest metanorma.release.yml
+metanorma-release package --output-dir _site --manifest metanorma.release.yml
 
 # Package and publish to a platform
-mn-release publish --platform github --output-dir _site --token $GITHUB_TOKEN
+metanorma-release publish --platform github --output-dir _site --token $GITHUB_TOKEN
 
 # Aggregate published releases into a file tree + index.json
-mn-release aggregate --source github --organizations my-org --output-dir _site/cc
+metanorma-release aggregate --source github --organizations my-org --output-dir _site/cc
 ----
 
 === Rake tasks
@@ -110,13 +110,13 @@ result.failed    # => [{ document: ..., error: "..." }]
 
 == CLI reference
 
-=== `mn-release package`
+=== `metanorma-release package`
 
 Package compiled documents into zip archives without publishing.
 
 [source,sh]
 ----
-mn-release package [options]
+metanorma-release package [options]
 ----
 
 [cols="1m,3",options="header"]
@@ -128,13 +128,13 @@ mn-release package [options]
 |`--config SOURCE` |Channel config file or platform ref
 |===
 
-=== `mn-release publish`
+=== `metanorma-release publish`
 
 Package and publish documents to a platform.
 
 [source,sh]
 ----
-mn-release publish [options]
+metanorma-release publish [options]
 ----
 
 [cols="1m,3",options="header"]
@@ -151,13 +151,13 @@ mn-release publish [options]
 |`--config SOURCE` |Channel config file or platform ref
 |===
 
-=== `mn-release aggregate`
+=== `metanorma-release aggregate`
 
 Aggregate published releases from multiple repositories into a unified file tree.
 
 [source,sh]
 ----
-mn-release aggregate [options]
+metanorma-release aggregate [options]
 ----
 
 [cols="1m,3",options="header"]

data/lib/metanorma/release/aggregation_interfaces.rb

@@ -20,12 +20,6 @@ module Metanorma
       end
     end
 
-    module IndexGenerator
-      def generate(documents, output_dir, format:, parameters:)
-        raise NotImplementedError, "#{self.class} must implement #generate"
-      end
-    end
-
     FetchResult = Struct.new(:releases, :etag, :unchanged?, keyword_init: true)
     RepoReport  = Struct.new(:releases, :included, :skipped, :reason, :errors, keyword_init: true)
     RepoError   = Struct.new(:tag, :message, keyword_init: true)

data/lib/metanorma/release/cli.rb

@@ -14,7 +14,7 @@ module Metanorma
         when 'publish'   then run_publish(argv)
         when 'aggregate' then run_aggregate(argv)
         when nil
-          warn 'Usage: mn-release <package|publish|aggregate> [options]'
+          warn 'Usage: metanorma-release <package|publish|aggregate> [options]'
           exit 2
         else
           warn "Unknown command: #{command}"
@@ -54,7 +54,7 @@ module Metanorma
           options = { output_dir: '_site', dest: 'dist', manifest: 'metanorma.release.yml',
                       config_source: nil }
           OptionParser.new do |opts|
-            opts.banner = 'Usage: mn-release package [options]'
+            opts.banner = 'Usage: metanorma-release package [options]'
             opts.on('--output-dir DIR', 'Compiled docs directory') { |v| options[:output_dir] = v }
             opts.on('--dest DIR', 'Destination for packages') { |v| options[:dest] = v }
             opts.on('--manifest FILE', 'Release manifest file') { |v| options[:manifest] = v }
@@ -68,7 +68,7 @@ module Metanorma
                       force: false, force_replace: [], channels: nil, concurrency: 4, token: nil,
                       config_source: nil }
           OptionParser.new do |opts|
-            opts.banner = 'Usage: mn-release publish [options]'
+            opts.banner = 'Usage: metanorma-release publish [options]'
             opts.on('--platform NAME', 'github|local') { |v| options[:platform] = v }
             opts.on('--output-dir DIR', 'Compiled docs directory') { |v| options[:output_dir] = v }
             opts.on('--manifest FILE', 'Release manifest file') { |v| options[:manifest] = v }
@@ -88,7 +88,7 @@ module Metanorma
                       file_routing: 'by-document', cache_dir: nil,
                       include_drafts: false, concurrency: 4, min_documents: 0, token: nil }
           OptionParser.new do |opts|
-            opts.banner = 'Usage: mn-release aggregate [options]'
+            opts.banner = 'Usage: metanorma-release aggregate [options]'
             opts.on('--source SOURCE', 'github|local:PATH') { |v| options[:source] = v }
             opts.on('--organizations ORGS', 'Comma-separated org list') { |v| options[:organizations] = v.split(',') }
             opts.on('--topic TOPIC', 'Repository topic') { |v| options[:topic] = v }

data/lib/metanorma/release/version.rb

@@ -2,6 +2,6 @@
 
 module Metanorma
   module Release
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

data/lib/metanorma/release.rb

@@ -86,7 +86,6 @@ module Metanorma
     autoload :RepoDiscoverer,    'metanorma/release/aggregation_interfaces'
     autoload :ReleaseFetcher,    'metanorma/release/aggregation_interfaces'
     autoload :ManifestReader,    'metanorma/release/aggregation_interfaces'
-    autoload :IndexGenerator,    'metanorma/release/aggregation_interfaces'
     autoload :FetchResult,       'metanorma/release/aggregation_interfaces'
     autoload :RepoReport,        'metanorma/release/aggregation_interfaces'
     autoload :RepoError,         'metanorma/release/aggregation_interfaces'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-release
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ribose Inc.
@@ -59,7 +59,7 @@ description: 'Manages the full release lifecycle of Metanorma documents: discove
 email:
 - open.source@ribose.com
 executables:
-- mn-release
+- metanorma-release
 extensions: []
 extra_rdoc_files: []
 files:
@@ -70,7 +70,7 @@ files:
 - PROMPT.md
 - README.adoc
 - Rakefile
-- exe/mn-release
+- exe/metanorma-release
 - lib/metanorma/release.rb
 - lib/metanorma/release/aggregation_interfaces.rb
 - lib/metanorma/release/aggregation_pipeline.rb