#59 Copy improvements from template-go (#60)

* #59 Copy improvements from template-go * #59 Copy improvements from template-go * #59 Copy improvements from template-go * #59 Fix linting
senzing-garage · Aug 30, 2024 · 20e13bf · 20e13bf
1 parent 3b064ce
commit 20e13bf
Show file tree

Hide file tree

Showing 10 changed files with 102 additions and 27 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -3,7 +3,7 @@
 
 version: 2
 updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
+  - package-ecosystem: github-actions
+    directory: /
     schedule:
-      interval: "daily"
+      interval: daily
diff --git a/.github/workflows/README.md b/.github/workflows/README.md
@@ -0,0 +1,73 @@
+# Workflows
+
+## add-labels-standardized.yaml
+
+When issues are opened,
+this action adds appropriate labels to the issue.
+(e.g. "triage", "customer-submission")
+
+- [Add Labels Standardized GitHub Action]
+  - Uses: [senzing-factory/build-resources/.../add-labels-to-issue.yaml]
+
+## add-to-project-garage-dependabot.yaml
+
+When a Dependabot Pull Request (PR) is made against `main` branch,
+this action adds the PR to the "Garage" project board as "In Progress".
+
+- [Add to Project Garage Dependabot GitHub Action]
+  - Uses: [senzing-factory/build-resources/.../add-to-project-dependabot.yaml]
+
+## add-to-project-garage.yaml
+
+When an issue is created,
+this action adds the issue to the "Garage" board as "Backlog".
+
+- [Add to Project Garage GitHub Action]
+  - Uses: [senzing-factory/build-resources/.../add-to-project.yaml]
+
+## dependabot-approve-and-merge.yaml
+
+When a Dependabot Pull Request (PR) is made against the `main` branch,
+this action determines if it should be automatically approved and merged into the `main` branch.
+Once this action occurs [move-pr-to-done-dependabot.yaml] moves the PR on the "Garage" project board to "Done".
+
+- [Dependabot Approve and Merge GitHub Action]
+  - Uses: [senzing-factory/build-resources/.../dependabot-approve-and-merge.yaml]
+
+## lint-workflows.yaml
+
+When a change is committed to GitHub or a Pull Request is made against the `main` branch,
+this action runs [super-linter] to run multiple linters against the code.
+
+- [Lint Workflows GitHub Action]
+  - Configuration:
+    - [.checkov.yaml]
+    - [.jscpd.json]
+    - [.yaml-lint.yml]
+  - Uses: [senzing-factory/build-resources/.../lint-workflows.yaml]
+
+## move-pr-to-done-dependabot.yaml
+
+When a Pull Request is merged into the `main` branch,
+this action moves the PR on the "Garage" project board to "Done".
+
+- [Move PR to Done Dependabot GitHub Action]
+  - Uses: [senzing-factory/build-resources/.../move-pr-to-done-dependabot.yaml]
+
+[.checkov.yaml]: ../linters/README.md#checkovyaml
+[.jscpd.json]: ../linters/README.md#jscpdjson
+[.yaml-lint.yml]: ../linters/README.md#yaml-lintyml
+[Add Labels Standardized GitHub Action]: add-labels-standardized.yaml
+[Add to Project Garage Dependabot GitHub Action]: add-to-project-garage-dependabot.yaml
+[Add to Project Garage GitHub Action]: add-to-project-garage.yaml
+[Dependabot Approve and Merge GitHub Action]: dependabot-approve-and-merge.yaml
+[Lint Workflows GitHub Action]: lint-workflows.yaml
+[Move PR to Done Dependabot GitHub Action]: move-pr-to-done-dependabot.yaml
+[move-pr-to-done-dependabot.yaml]: move-pr-to-done-dependabotyaml
+[senzing-factory/build-resources/.../add-labels-to-issue.yaml]: https://github.com/senzing-factory/build-resources/blob/main/.github/workflows/add-labels-to-issue.yaml
+[senzing-factory/build-resources/.../add-to-project-dependabot.yaml]: https://github.com/senzing-factory/build-resources/blob/main/.github/workflows/add-to-project-dependabot.yaml
+[senzing-factory/build-resources/.../add-to-project.yaml]: https://github.com/senzing-factory/build-resources/blob/main/.github/workflows/add-to-project.yaml
+[senzing-factory/build-resources/.../dependabot-approve-and-merge.yaml]: https://github.com/senzing-factory/build-resources/blob/main/.github/workflows/dependabot-approve-and-merge.yaml
+[senzing-factory/build-resources/.../lint-workflows.yaml]: https://github.com/senzing-factory/build-resources/blob/main/.github/workflows/lint-workflows.yaml
+[senzing-factory/build-resources/.../move-pr-to-done-dependabot.yaml]: https://github.com/senzing-factory/build-resources/blob/main/.github/workflows/move-pr-to-done-dependabot.yaml
+[super-linter]: https://github.com/super-linter/super-linter
diff --git a/.github/workflows/add-labels-standardized.yaml b/.github/workflows/add-labels-standardized.yaml
@@ -1,4 +1,4 @@
-name: add labels standardized
+name: Add labels standardized
 
 on:
   issues:

diff --git a/.github/workflows/add-to-project-garage-dependabot.yaml b/.github/workflows/add-to-project-garage-dependabot.yaml
@@ -1,4 +1,4 @@
-name: add to project garage dependabot
+name: Add to project garage dependabot
 
 on:
   pull_request:

diff --git a/.github/workflows/add-to-project-garage.yaml b/.github/workflows/add-to-project-garage.yaml
@@ -1,4 +1,4 @@
-name: add to project garage
+name: Add to project garage
 
 on:
   issues:

diff --git a/.github/workflows/dependabot-approve-and-merge.yaml b/.github/workflows/dependabot-approve-and-merge.yaml
@@ -1,4 +1,4 @@
-name: dependabot approve and merge
+name: Dependabot approve and merge
 
 on:
   pull_request:

diff --git a/.github/workflows/lint-workflows.yaml b/.github/workflows/lint-workflows.yaml
@@ -1,4 +1,4 @@
-name: lint workflows
+name: Lint workflows
 
 on:
   push:

diff --git a/.github/workflows/move-pr-to-done-dependabot.yaml b/.github/workflows/move-pr-to-done-dependabot.yaml
@@ -1,4 +1,4 @@
-name: move pr to done dependabot
+name: Move pr to done dependabot
 
 on:
   pull_request:

diff --git a/README.md b/README.md
@@ -3,8 +3,7 @@
 If you are beginning your journey with [Senzing],
 please start with [Senzing Quick Start guides].
 
-You are in the [Senzing Garage]
-where projects are "tinkered" on.
+You are in the [Senzing Garage] where projects are "tinkered" on.
 Although this GitHub repository may help you understand an approach to using Senzing,
 it's not considered to be "production ready" and is not considered to be part of the Senzing product.
 Heck, it may not even be appropriate for your application of Senzing!
@@ -38,6 +37,7 @@ Although the file you are reading is a `README.md` file, this isn't the style of
 Depending upon the type of repository, the following `README.md` templates may be more appropriate:
 
 Examples:
+
   1. [template-docker/README.md]
   1. [template-go/README.md]
   1. [template-python/README.md]
@@ -157,8 +157,7 @@ The `LICENSE` file describes the terms and conditions under which the code in th
 The recommended license file is "[Apache License 2.0]".
 A comparison of licenses can be found at [choosealicense.com].
 
-The [LICENSE](LICENSE) file in this repository is based on
-"[Apache License 2.0]".
+The [LICENSE file] in this repository is based on "[Apache License 2.0]".
 
 ### How to create LICENSE
 
@@ -167,46 +166,46 @@ The [LICENSE](LICENSE) file in this repository is based on
 1. Option #2: Manual file creation
     1. See GitHub's [Adding a license to a repository]
 
+[.github/CODEOWNERS]: .github/CODEOWNERS
 [Adding a code of conduct to your project]: https://help.github.com/articles/adding-a-code-of-conduct-to-your-project/
 [Adding a license to a repository]: https://help.github.com/articles/adding-a-license-to-a-repository/
 [Apache License 2.0]: https://www.apache.org/licenses/LICENSE-2.0.html
 [Apache Software Foundation Code of Conduct]: https://www.apache.org/foundation/policies/conduct.html
-[CHANGELOG]: CHANGELOG.md
 [CHANGELOG.md]: #changelogmd
+[CHANGELOG]: CHANGELOG.md
 [choosealicense.com]: https://choosealicense.com/licenses/
 [code owners]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
-[CODEOWNERS]: #githubcodeowners
-[dependabot.yml]: .github/dependabot.yml
-[.github/CODEOWNERS]: .github/CODEOWNERS
-[CODE_OF_CONDUCT]: CODE_OF_CONDUCT.md
 [CODE_OF_CONDUCT.md]: #code_of_conductmd
+[CODE_OF_CONDUCT]: CODE_OF_CONDUCT.md
+[CODEOWNERS]: #githubcodeowners
 [Community]: https://github.com/senzing-factory/template-repository/community
-[CONTRIBUTING]: CONTRIBUTING.md
 [CONTRIBUTING.md]: #contributingmd
+[CONTRIBUTING]: CONTRIBUTING.md
 [Contributor Covenant]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 [creating a new repository]: https://github.com/new
 [dependabot.yml]: #githubdependabotyml
 [docs]: docs
 [docs/]: #docs
+[GitHub Pages]: https://pages.github.com/
 [github.com]: https://github.com/
 [github.com/orgs/Senzing/teams]: https://github.com/orgs/Senzing/teams
 [GitHub's dependabot]: https://docs.github.com/en/code-security/dependabot
-[GitHub Pages]: https://pages.github.com/
 [hub.senzing.com]: https://hub.senzing.com/
 [hub.senzing.com/sdk-components-ng]: https://hub.senzing.com/sdk-components-ng/
 [Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
+[LICENSE file]: LICENSE
 [LICENSE]: #license
 [markdownlint]: https://dlaa.me/markdownlint/
 [Open Source Guide]: https://opensource.guide/code-of-conduct/
 [README.md]: #readmemd
 [Semantic Versioning]: https://semver.org/spec/v2.0.0.html
-[Senzing]: https://senzing.com/
-[senzing-corporate-contributor-license-agreement]: #githubsenzing-corporate-contributor-license-agreementpdf
-[senzing-corporate-contributor-license-agreement.pdf]: .github/senzing-corporate-contributor-license-agreement.pdf
 [Senzing Garage]: https://github.com/senzing-garage
-[senzing-individual-contributor-license-agreement]: #githubsenzing-individual-contributor-license-agreementpdf
-[senzing-individual-contributor-license-agreement.pdf]: .github/senzing-individual-contributor-license-agreement.pdf
 [Senzing Quick Start guides]: https://docs.senzing.com/quickstart/
+[senzing-corporate-contributor-license-agreement.pdf]: .github/senzing-corporate-contributor-license-agreement.pdf
+[senzing-corporate-contributor-license-agreement]: #githubsenzing-corporate-contributor-license-agreementpdf
+[senzing-individual-contributor-license-agreement.pdf]: .github/senzing-individual-contributor-license-agreement.pdf
+[senzing-individual-contributor-license-agreement]: #githubsenzing-individual-contributor-license-agreementpdf
+[Senzing]: https://senzing.com/
 [Setting guidelines for repository contributors]: https://help.github.com/articles/setting-guidelines-for-repository-contributors/
 [template-docker/README.md]: https://github.com/senzing-garage/template-docker/blob/main/README.md
 [template-go/README.md]: https://github.com/senzing-garage/template-go/blob/main/README.md

diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,8 @@
 # template-repository
 
-Placeholder for [GitHub pages](https://pages.github.com/).
+Placeholder for [GitHub pages].
 
-See [https://hub.senzing.com/template-repository](https://hub.senzing.com/template-repository).
+See [GitHub page].
+
+[GitHub page]: https://garage.senzing.com/template-repository
+[GitHub pages]: https://pages.github.com/