Add consistent explanatory comments

voxpupuli · Jul 8, 2021 · 01cfc20 · 01cfc20
1 parent 7e4c4ad
commit 01cfc20
Show file tree

Hide file tree

Showing 16 changed files with 48 additions and 6 deletions.
diff --git a/moduleroot/.editorconfig.erb b/moduleroot/.editorconfig.erb
@@ -1,6 +1,7 @@
 # editorconfig.org
 
-# MANAGED BY MODULESYNC
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
 
 root = true
 

diff --git a/moduleroot/.github/workflows/ci.yml.erb b/moduleroot/.github/workflows/ci.yml.erb
@@ -1,3 +1,7 @@
+---
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 name: CI
 
 on: pull_request

diff --git a/moduleroot/.github/workflows/release.yml.erb b/moduleroot/.github/workflows/release.yml.erb
@@ -1,3 +1,7 @@
+---
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 name: Release
 
 on:

diff --git a/moduleroot/.gitignore.erb b/moduleroot/.gitignore.erb
@@ -1,3 +1,6 @@
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 pkg/
 Gemfile.lock
 Gemfile.local

diff --git a/moduleroot/.msync.yml.erb b/moduleroot/.msync.yml.erb
@@ -1,2 +1,5 @@
 ---
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 modulesync_config_version: '4.1.0'
diff --git a/moduleroot/.overcommit.yml.erb b/moduleroot/.overcommit.yml.erb
@@ -1,4 +1,5 @@
-# Managed by https://github.com/voxpupuli/modulesync_configs
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
 #
 # Hooks are only enabled if you take action.
 #

diff --git a/moduleroot/.pmtignore.erb b/moduleroot/.pmtignore.erb
@@ -1,3 +1,6 @@
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 docs/
 pkg/
 Gemfile

diff --git a/moduleroot/.rspec.erb b/moduleroot/.rspec.erb
@@ -1,2 +1,5 @@
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 --format documentation
 --color
diff --git a/moduleroot/.rspec_parallel.erb b/moduleroot/.rspec_parallel.erb
@@ -1 +1,4 @@
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 --format progress
diff --git a/moduleroot/.rubocop.yml.erb b/moduleroot/.rubocop.yml.erb
@@ -1,3 +1,6 @@
 ---
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 inherit_gem:
   voxpupuli-test: rubocop.yml
diff --git a/moduleroot/.yardopts.erb b/moduleroot/.yardopts.erb
@@ -1,2 +1,5 @@
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 --markup markdown
 --output-dir docs/
diff --git a/moduleroot/Dockerfile.erb b/moduleroot/Dockerfile.erb
@@ -1,3 +1,6 @@
+# MANAGED BY MODULESYNC
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 FROM ruby:2.7
 
 WORKDIR /opt/puppet

diff --git a/moduleroot/Gemfile.erb b/moduleroot/Gemfile.erb
@@ -1,3 +1,6 @@
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 source ENV['GEM_SOURCE'] || "https://rubygems.org"
 
 <% groups = {} -%>

diff --git a/moduleroot/Rakefile.erb b/moduleroot/Rakefile.erb
@@ -1,3 +1,6 @@
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 # Attempt to load voxupuli-test (which pulls in puppetlabs_spec_helper),
 # otherwise attempt to load it directly.
 begin

diff --git a/moduleroot/spec/spec_helper.rb.erb b/moduleroot/spec/spec_helper.rb.erb
@@ -1,6 +1,6 @@
-# This file is managed via modulesync
-# https://github.com/voxpupuli/modulesync
-# https://github.com/voxpupuli/modulesync_config
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 <%- if @configs['mock_with'] -%>
 
 RSpec.configure do |c|

diff --git a/moduleroot/spec/spec_helper_acceptance.rb.erb b/moduleroot/spec/spec_helper_acceptance.rb.erb
@@ -1,4 +1,6 @@
-# This file is completely managed via modulesync
+# Managed by modulesync - DO NOT EDIT
+# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
+
 require 'voxpupuli/acceptance/spec_helper_acceptance'
 
 configure_beaker