Skip to content

Commit

Permalink
#59 Copy improvements from template-go
Browse files Browse the repository at this point in the history
  • Loading branch information
docktermj committed Aug 30, 2024
1 parent 3b064ce commit 8dbea23
Show file tree
Hide file tree
Showing 11 changed files with 168 additions and 44 deletions.
6 changes: 3 additions & 3 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
- package-ecosystem: github-actions
directory: /
schedule:
interval: "daily"
interval: daily
101 changes: 101 additions & 0 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# 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
[.golangci.yaml]: ../linters/README.md#golangciyaml
[.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
[Docker Build Container GitHub Action]: docker-build-container.yaml
[Docker Push Containers to DockerHub GitHub Action]: docker-push-containers-to-dockerhub.yaml
[DockerHub]: https://hub.docker.com/
[Go Proxy Pull GitHub Action]: go-proxy-pull.yaml
[Go Test Darwin GitHub Action]: go-test-darwin.yaml
[Go Test Linux GitHub Action]: go-test-linux.yaml
[Go Test Windows GitHub Action]: go-test-windows.yaml
[Go]: https://go.dev/
[Golangci Lint GitHub Action]: golangci-lint.yaml
[Lint Workflows GitHub Action]: lint-workflows.yaml
[Make Go GitHub File GitHub Action]: make-go-github-file.yaml
[Make Go Tag GitHub Action]: make-go-tag.yaml
[Move PR to Done Dependabot GitHub Action]: move-pr-to-done-dependabot.yaml
[Semantic Version]: https://semver.org/
[actions/checkout]: https://github.com/actions/checkout
[actions/setup-go]: https://github.com/actions/setup-go
[actions/upload-artifact]: https://github.com/actions/upload-artifact
[andrewslotin/go-proxy-pull-action]: https://github.com/andrewslotin/go-proxy-pull-action
[github.go]: ../../cmd/github.go
[golangci-lint]: https://github.com/golangci/golangci-lint
[golangci/golangci-lint-action]: https://github.com/golangci/golangci-lint-action
[gotesttools/gotestfmt-action]: https://github.com/gotesttools/gotestfmt-action
[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/.../go-coverage.yaml]: https://github.com/senzing-factory/build-resources/blob/main/.github/workflows/go-coverage.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/.../make-go-github-file.yaml]: https://github.com/senzing-factory/build-resources/blob/main/.github/workflows/make-go-github-file.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
[senzing-factory/github-action-docker-buildx-build]: https://github.com/senzing-factory/github-action-docker-buildx-build
[senzing-factory/github-action-install-senzing-api]: https://github.com/senzing-factory/github-action-install-senzing-api
[senzing-factory/github-action-make-go-tag]: https://github.com/senzing-factory/github-action-make-go-tag
[super-linter]: https://github.com/super-linter/super-linter
[testcoverage.yaml]: ../coverage/README.md#testcoverageyaml
2 changes: 1 addition & 1 deletion .github/workflows/add-labels-standardized.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: add labels standardized
name: Add labels standardized

on:
issues:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/add-to-project-garage-dependabot.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: add to project garage dependabot
name: Add to project garage dependabot

on:
pull_request:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/add-to-project-garage.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: add to project garage
name: Add to project garage

on:
issues:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/dependabot-approve-and-merge.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: dependabot approve and merge
name: Dependabot approve and merge

on:
pull_request:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint-workflows.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: lint workflows
name: Lint workflows

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/move-pr-to-done-dependabot.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: move pr to done dependabot
name: Move pr to done dependabot

on:
pull_request:
Expand Down
9 changes: 3 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog], [markdownlint],
and this project adheres to [Semantic Versioning].
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
[markdownlint](https://dlaa.me/markdownlint/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

Expand All @@ -26,7 +27,3 @@ and this project adheres to [Semantic Versioning].

- Thing 2
- Thing 1

[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
[markdownlint]: https://dlaa.me/markdownlint/
[Semantic Versioning]: https://semver.org/spec/v2.0.0.html
77 changes: 50 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down Expand Up @@ -157,8 +156,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

Expand All @@ -167,47 +165,72 @@ 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
[API documentation]: https://pkg.go.dev/github.com/senzing-garage/template-go
[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
[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
[CHANGELOG]: CHANGELOG.md
[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
[Community]: https://github.com/senzing-factory/template-repository/community
[CONTRIBUTING]: CONTRIBUTING.md
[CODE_OF_CONDUCT]: CODE_OF_CONDUCT.md
[CONTRIBUTING.md]: #contributingmd
[CONTRIBUTING]: CONTRIBUTING.md
[Community]: https://github.com/senzing-factory/template-repository/community
[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.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
[Development]: docs/development.md
[DockerHub]: https://hub.docker.com/r/senzing/template-go
[Errors]: docs/errors.md
[Examples]: docs/examples.md
[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/
[GitHub's dependabot]: https://docs.github.com/en/code-security/dependabot
[Go Package library]: https://pkg.go.dev
[Go Reference Badge]: https://pkg.go.dev/badge/github.com/senzing-garage/template-go.svg
[Go Report Card Badge]: https://goreportcard.com/badge/github.com/senzing-garage/template-go
[Go Report Card]: https://goreportcard.com/report/github.com/senzing-garage/template-go
[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
[LICENSE]: #license
[markdownlint]: https://dlaa.me/markdownlint/
[LICENSE file]: LICENSE
[License Badge]: https://img.shields.io/badge/License-Apache2-brightgreen.svg
[License]: https://github.com/senzing-garage/template-go/blob/main/LICENSE
[Open Source Guide]: https://opensource.guide/code-of-conduct/
[Package reference]: https://pkg.go.dev/github.com/senzing-garage/template-go
[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 Garage]: https://github.com/senzing-garage
[Senzing Quick Start guides]: https://docs.senzing.com/quickstart/
[Senzing Quick Start guides]: https://docs.senzing.com/quickstart/
[Senzing]: https://senzing.com/
[Senzing]: https://senzing.com/
[Setting guidelines for repository contributors]: https://help.github.com/articles/setting-guidelines-for-repository-contributors/
[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
[creating a new repository]: https://github.com/new
[dependabot.yml]: #githubdependabotyml
[dependabot.yml]: .github/dependabot.yml
[docs/]: #docs
[docs]: docs
[github.com/orgs/Senzing/teams]: https://github.com/orgs/Senzing/teams
[github.com]: https://github.com/
[go-test-darwin.yaml Badge]: https://github.com/senzing-garage/template-go/actions/workflows/go-test-darwin.yaml/badge.svg
[go-test-darwin.yaml]: https://github.com/senzing-garage/template-go/actions/workflows/go-test-darwin.yaml
[go-test-linux.yaml Badge]: https://github.com/senzing-garage/template-go/actions/workflows/go-test-linux.yaml/badge.svg
[go-test-linux.yaml]: https://github.com/senzing-garage/template-go/actions/workflows/go-test-linux.yaml
[go-test-windows.yaml Badge]: https://github.com/senzing-garage/template-go/actions/workflows/go-test-windows.yaml/badge.svg
[go-test-windows.yaml]: https://github.com/senzing-garage/template-go/actions/workflows/go-test-windows.yaml
[golangci-lint.yaml Badge]: https://github.com/senzing-garage/template-go/actions/workflows/golangci-lint.yaml/badge.svg
[golangci-lint.yaml]: https://github.com/senzing-garage/template-go/actions/workflows/golangci-lint.yaml
[hub.senzing.com/sdk-components-ng]: https://hub.senzing.com/sdk-components-ng/
[hub.senzing.com]: https://hub.senzing.com/
[main.go]: main.go
[markdownlint]: https://dlaa.me/markdownlint/
[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
[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
[template-python/README.md]: https://github.com/senzing-garage/template-python/blob/main/README.md
7 changes: 5 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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/

0 comments on commit 8dbea23

Please sign in to comment.