Merge pull request #148 from sous-chefs/automated/standardfiles

Automated PR: Standardising Files

.circleci/config.yml

@@ -0,0 +1,10 @@
+---
+version: 2.1
+orbs:
+  kitchen: sous-chefs/kitchen@2
+workflows:
+  danger:
+    jobs:
+      - kitchen/danger:
+          name: danger
+          context: Danger-Minimal

.envrc

@@ -0,0 +1 @@
+use chefworkstation

.github/workflows/md-links.yml

@@ -0,0 +1,19 @@
+---
+name: md-links
+
+"on":
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  md-links:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@master
+      - name: markdown-link-check
+        uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          use-verbose-mode: "yes"
+          folder-path: "documentation"

.github/workflows/stale.yml

@@ -0,0 +1,28 @@
+---
+name: Mark stale issues and pull requests
+
+"on":
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/stale@v3
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          close-issue-message: >
+            Closing due to inactivity.
+            If this is still an issue please reopen or open another issue.
+            Alternatively drop by the #sous-chefs channel on the [Chef Community Slack](http://community-slack.chef.io/) and we'll be happy to help!
+            Thanks, Sous-Chefs.
+          days-before-close: 7
+          days-before-stale: 365
+          stale-issue-message: >
+            Marking stale due to inactivity.
+            Remove stale label or comment or this will be closed in 7 days.
+            Alternatively drop by the #sous-chefs channel on the [Chef Community Slack](http://community-slack.chef.io/) and we'll be happy to help!
+            Thanks, Sous-Chefs.

.gitignore

@@ -1,7 +1,6 @@
 *.rbc
 .config
 InstalledFiles
-lib/bundler/man
 pkg
 test/tmp
 test/version_tmp
@@ -16,11 +15,11 @@ _Store
 *.bk
 *.bkup
 
-# editor temp files
+# editor files
 .idea
 .*.sw[a-z]
 
-# ruby/bundler files
+# ruby/bundler/rspec files
 .ruby-version
 .ruby-gemset
 .rvmrc

.overcommit.yml

@@ -0,0 +1,20 @@
+---
+PreCommit:
+  TrailingWhitespace:
+    enabled: true
+  YamlLint:
+    enabled: true
+  Rspec:
+    enabled: true
+    required_executable: 'rspec'
+  Cookstyle:
+    enabled: true
+    required_executable: 'cookstyle'
+    command: ["cookstyle"]
+  Delivery:
+    enabled: true
+    required_executable: 'delivery'
+    flags: ['local', 'all']
+CommitMsg:
+  HardTabs:
+    enabled: true

.vscode/extensions.json

@@ -4,4 +4,4 @@
       "rebornix.ruby",
       "editorconfig.editorconfig"
   ]
-}
+}

.yamllint

@@ -0,0 +1,7 @@
+---
+extends: default
+rules:
+  line-length:
+    max: 256
+    level: warning
+  document-start: disable

CODE_OF_CONDUCT.md

@@ -1 +1,3 @@
-Please refer to the Chef Community Code of Conduct at <https://www.chef.io/code-of-conduct/>
+# Community Guidelines
+
+This project follows the Chef Community Guidelines <https://docs.chef.io/community_guidelines.html>

CONTRIBUTING.md

@@ -1,2 +1,4 @@
+# Contributing
+
 Please refer to
-https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD
+[https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD](https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD)

Dangerfile

@@ -0,0 +1,47 @@
+# Reference: http://danger.systems/reference.html
+
+# A pull request summary is required. Add a description of the pull request purpose.
+# Changelog must be updated for each pull request that changes code.
+# Warnings will be issued for:
+#    Pull request with more than 400 lines of code changed
+#    Pull reqest that change more than 5 lines without test changes
+# Failures will be issued for:
+#    Pull request without summary
+#    Pull requests with code changes without changelog entry
+
+def code_changes?
+  code = %w(libraries attributes recipes resources files templates)
+  code.each do |location|
+    return true unless git.modified_files.grep(/#{location}/).empty?
+  end
+  false
+end
+
+def test_changes?
+  tests = %w(spec test kitchen.yml kitchen.dokken.yml)
+  tests.each do |location|
+    return true unless git.modified_files.grep(/#{location}/).empty?
+  end
+  false
+end
+
+failure 'Please provide a summary of your Pull Request.' if github.pr_body.length < 10
+
+warn 'This is a big Pull Request.' if git.lines_of_code > 400
+
+warn 'This is a Table Flip.' if git.lines_of_code > 2000
+
+# Require a CHANGELOG entry for non-test changes.
+if !git.modified_files.include?('CHANGELOG.md') && code_changes?
+  failure 'Please include a CHANGELOG entry.'
+end
+
+# Require Major Minor Patch version labels
+unless github.pr_labels.grep /minor|major|patch/i
+  warn 'Please add a release label to this pull request'
+end
+
+# A sanity check for tests.
+if git.lines_of_code > 5 && code_changes? && !test_changes?
+  warn 'This Pull Request is probably missing tests.'
+end

TESTING.md

@@ -1,2 +1,3 @@
-Please refer to
-<https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/TESTING.MD>
+# Testing
+
+Please refer to [the community cookbook documentation on testing](https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/TESTING.MD).