rails_template_18f 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a69496a0836c43df3d636ecf91d120c5975b8462ab285edaacc2494b3af8265f
-  data.tar.gz: 7d1fbc494eb83d99bb0f498fc983db9dd6d45c1ca37895da5a60876c5fea5d0f
+  metadata.gz: ec09af68270ab8a9c37472e382f4f5c847e2b14a5d865d5d0b161fdb7a5fc6c2
+  data.tar.gz: f83f58fc2fe89dc1d9516874138452ac2a6331aebaee7db9458abe1bc72c2cd2
 SHA512:
-  metadata.gz: 35b93c784bd2fd885745e300e16d054861ef48303dfde9167a6c21edaeb0e78c846a950e99d51d559868f71275c341443a158bd84b766b9b0a822d2d68606d25
-  data.tar.gz: 10703f7f1a3a75ecdd62fcc05123058b75dd6d9685121ee0bb38f0014d3354ab15ff2b4f30619439c436d4be2c58247d4e07ec65172c49c769c2b346e7802023
+  metadata.gz: 63584d2d0737790f36294c34e7e8d3611cf2d4e930e6664582b1d812e9d6117b609ba1912f40a2243d5bb24178cf989fddc1c3db8e29f41e178e188bd1e576bd
+  data.tar.gz: 6e78c92eb7cb24522aedb57c91a82ba077fd6780f4b34f0f138953e0ca4992daefcf610e0a934c10f32fee785e7dd72335ea2fbd87e4839d64dbae42cdc6a592

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.7.1] - 2022-07-05
+
+- fix issue with initial git commit when no OSCAL docs were updated during initial app creation
+- add extra content to project README about working with submodules
+
 ## [0.7.0] - 2022-07-05
 
 - OSCAL generator to integrate with https://github.com/GSA-TTS/compliance-template

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_template_18f (0.7.0)
+    rails_template_18f (0.7.1)
       activesupport (~> 7.0.0)
       colorize (~> 0.8)
       railties (~> 7.0.0)

data/lib/generators/rails_template18f/oscal/oscal_generator.rb

@@ -44,30 +44,54 @@ module RailsTemplate18f
         end
       end
 
+      def configure_submodule
+        unless detach?
+          git config: "-f .gitmodules submodule.\"doc/compliance/oscal\".branch #{branch_name}"
+          git config: "diff.submodule log"
+          git config: "status.submodulesummary 1"
+          git config: "push.recurseSubmodules check"
+        end
+      end
+
       no_tasks do
         def branch_name
           options[:branch].present? ? options[:branch] : app_name
         end
 
         def readme_contents
-          if detach?
-            <<~README
+          content = <<~README
 
-              ### Compliance Documentation
+            ### Compliance Documentation
 
-              Security Controls should be documented within doc/compliance/oscal.
-            README
-          else
-            <<~README
+            Security Controls should be documented within doc/compliance/oscal.
+          README
+          return content if detach?
+          <<~README
+            #{content}
 
-              ### Compliance Documentation
+            #### Git Submodule Commands
 
-              Security Controls should be documented within doc/compliance/oscal.
+            See git's [submodule documentation](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
+            for more information on tracking changes to these files.
 
-              See git's [submodule documentation](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
-              for more information on tracking changes to these files.
-            README
-          end
+            ##### Cloning this project
+
+            `git clone --recurse-submodules <<REPO_ADDRESS>>`
+
+            ##### Pull changes including OSCAL changes
+
+            `git pull --recurse-submodules`
+
+            ##### Push changes including OSCAL changes
+
+            `git push --recurse-submodules=check` _then_ `git push --recurse-submodules=on-demand`
+
+            ##### Helpful config settings:
+
+            * `git config diff.submodule log`
+            * `git config status.submodulesummary 1`
+            * `git config push.recurseSubmodules check`
+          README
         end
 
         def detach?

data/lib/rails_template18f/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsTemplate18f
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/template.rb

@@ -483,7 +483,8 @@ after_bundle do
     EOM
     if compliance_template_submodule
       inside "doc/compliance/oscal" do
-        git commit: "-a -m 'rails-template generated control statements'"
+        run "git add -A"
+        run "git diff-index --quiet HEAD || git commit -am 'rails-template generated control statements'"
       end
     end
     git add: "."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_template_18f
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Ryan Ahearn