update rake tasks:

- remove :html task - rename :md => :readme
kowal · Sep 19, 2023 · 117788b · 117788b
1 parent 3c701e1
commit 117788b
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 117 deletions.
diff --git a/README.md b/README.md
@@ -123,6 +123,7 @@ To rebuild documentation pages from `templates/docs/**`:
 
     $ rake doc
     # Writing to mkdocs-material/docs/versions-latest.md .. Done
+    # Writing to docs/docs/versions-all.md .. Done
     # ...
 
 To start documentation app locally:
@@ -138,9 +139,9 @@ Deployment to github Pages is set up via [github actions](https://squidfunk.gith
 
 #### Readme
 
-To rebuild `README.md` from `templates/README.md.erb`:
+To rebuild this `README.md` from `templates/README.md.erb`:
 
-    $ rake md
+    $ rake readme
     # Writing to README.MD .. Done
 
     $ yield

diff --git a/Rakefile b/Rakefile
@@ -1,20 +1,15 @@
 require_relative 'lib/ruby_changelog'
 
-task default: :html
-
-desc 'Generate single html page with changelog'
-task :html do
-  RubyChangelog::Actions.new.generate_html
-end
+task default: :doc
 
 desc 'Generate README file with changelog'
-task :md do
+task :readme do
   RubyChangelog::Actions.new.generate_readme
 end
 
 desc 'Generate full documentation'
 task :doc do
-  RubyChangelog::Actions.new.generate_full_docs
+  RubyChangelog::Actions.new.generate_docs
 end
 
 namespace :fetch do

diff --git a/architecture.html b/architecture.html
@@ -9,12 +9,10 @@ <h2>Overview</h2>
   <div class="mermaid">
     flowchart LR
     A0[(fa:fa-database Data source<br><br>/data/ruby_versions.json<br>/data/ruby_cve.json)] -. uses JSON files as data source .-> B[main Changelog class]
-    A1[fa:fa-user rake html]      --> B[fa:fa-cogs main Changelog class]
-    A2[fa:fa-user rake md]        --> B
+    A2[fa:fa-user rake readme]    --> B
     A3[fa:fa-user rake doc]       --> B
     A4[fa:fa-user rake fetch:cve] --> B
 
-    B --> D(fa:fa-bolt Genereate static HTML)        --> dd::out[fa:fa-arrow-circle-o-right fa:fa-file-text-o index.html]
     B --> E(fa:fa-bolt Genereate readme in Markdown) --> ee::out[fa:fa-arrow-circle-o-right fa:fa-file-text-o README.md]
     B --> F(fa:fa-bolt Genereate MkDocs md files)    --> ff::out[fa:fa-arrow-circle-o-right fa:fa-file-text-o docs/docs/*.md files]
     B --> G(fa:fa-bolt Fetch CVE data) --> A0

diff --git a/docs/docs/versions-all.md b/docs/docs/versions-all.md
@@ -579,4 +579,4 @@
 
 ----
 
-(Last updated on 2023-09-19 22:38:24 +0200)
+(Last updated on 2023-09-19 23:11:27 +0200)
diff --git a/docs/docs/versions-latest.md b/docs/docs/versions-latest.md
@@ -346,4 +346,4 @@ This will be reversed again in Ruby 3.0.0</code>
 
 ----
 
-(Last updated on 2023-09-19 22:38:24 +0200)
+(Last updated on 2023-09-19 23:11:27 +0200)
diff --git a/lib/ruby_changelog/actions.rb b/lib/ruby_changelog/actions.rb
@@ -5,60 +5,42 @@ module RubyChangelog
   CHANGELOG_SOURCE = 'data/ruby_versions.json'.freeze
   CVE_SOURCE       = 'data/ruby_cve.json'.freeze
 
-  OUTPUT_HTML      = 'index.html'.freeze
   OUTPUT_README_MD = 'README.MD'.freeze
 
   TEMPLATE_BASE                    = 'lib/templates'.freeze
-  TEMPLATE_HTML                    = "#{TEMPLATE_BASE}/index.html.erb".freeze
   TEMPLATE_MD                      = "#{TEMPLATE_BASE}/README.md.erb".freeze
-  TEMPLATE_DOCS_VERSIONS_LATEST_MD = "#{TEMPLATE_BASE}/docs/versions/LATEST.md.erb".freeze
+  TEMPLATE_DOCS_VERSIONS_LATEST_MD = "#{TEMPLATE_BASE}/docs/versions/latest.md.erb".freeze
   TEMPLATE_DOCS_VERSIONS_ALL_MD    = "#{TEMPLATE_BASE}/docs/versions/all.md.erb".freeze
   TEMPLATE_DOCS_TIMELINE_JS        = "#{TEMPLATE_BASE}/docs/charts/timeline.js.erb".freeze
 
   DOCS_BASE                        = 'docs'.freeze
   DOCS_VERSIONS_LATEST_MD          = "#{DOCS_BASE}/docs/versions-latest.md".freeze
   DOCS_VERSIONS_ALL_MD             = "#{DOCS_BASE}/docs/versions-all.md".freeze
+  DOCS_CHARTS_TIMELINE_MD          = "#{DOCS_BASE}/docs/timeline.md".freeze
   DOCS_CHARTS_TIMELINE_JS          = "#{DOCS_BASE}/docs/javascripts/charts-timeline.js".freeze
 
   class Actions
-    def generate_html
-      save_file(
-        OUTPUT_HTML,
-        generate_file(TEMPLATE_HTML, ruby_versions: ruby_versions_data)
-      )
-    end
-
     def generate_readme
       save_file(
         OUTPUT_README_MD,
         generate_file(TEMPLATE_MD, ruby_versions: ruby_versions_data)
       )
     end
 
-    def generate_full_docs
+    def generate_docs
       save_file(
         DOCS_VERSIONS_LATEST_MD,
-        generate_file(
-          TEMPLATE_DOCS_VERSIONS_LATEST_MD,
-          ruby_versions: ruby_versions_data
-        )
+        generate_file(TEMPLATE_DOCS_VERSIONS_LATEST_MD, ruby_versions: ruby_versions_data)
       )
 
       save_file(
         DOCS_VERSIONS_ALL_MD,
-        generate_file(
-          TEMPLATE_DOCS_VERSIONS_ALL_MD,
-          ruby_versions: ruby_versions_data,
-          ruby_cve: ruby_cve_data
-        )
+        generate_file(TEMPLATE_DOCS_VERSIONS_ALL_MD, ruby_versions: ruby_versions_data, ruby_cve: ruby_cve_data)
       )
 
       save_file(
         DOCS_CHARTS_TIMELINE_JS,
-        generate_file(
-          TEMPLATE_DOCS_TIMELINE_JS,
-          ruby_versions: ruby_versions_data
-        )
+        generate_file(TEMPLATE_DOCS_TIMELINE_JS, ruby_versions: ruby_versions_data)
       )
     end
 

diff --git a/lib/templates/README.md.erb b/lib/templates/README.md.erb
@@ -31,6 +31,7 @@ To rebuild documentation pages from `templates/docs/**`:
 
     $ rake doc
     # Writing to mkdocs-material/docs/versions-latest.md .. Done
+    # Writing to docs/docs/versions-all.md .. Done
     # ...
 
 To start documentation app locally:
@@ -46,9 +47,9 @@ Deployment to github Pages is set up via [github actions](https://squidfunk.gith
 
 #### Readme
 
-To rebuild `README.md` from `templates/README.md.erb`:
+To rebuild this `README.md` from `templates/README.md.erb`:
 
-    $ rake md
+    $ rake readme
     # Writing to README.MD .. Done
 
     $ yield

diff --git a/lib/templates/index.html.erb b/lib/templates/index.html.erb