diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml new file mode 100644 index 0000000..123fbda --- /dev/null +++ b/.github/workflows/benchmark.yml @@ -0,0 +1,28 @@ +name: gobenchdata publish + +on: + workflow_call: + push: + branches: + - master + - develop + pull_request: + branches: + - master + - develop + +jobs: + publish: + runs-on: ubuntu-latest + steps: + - name: checkout + uses: actions/checkout@v2 + - name: gobenchdata publish + uses: bobheadxi/gobenchdata@v1 + with: + PRUNE_COUNT: 10 + GO_TEST_FLAGS: -cpu 1,2 + PUBLISH: true + PUBLISH_BRANCH: gh-pages + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..b3533a6 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,20 @@ +on: + pull_request: + branches: + - master + - develop + workflow_call: + push: + branches: + - master + - develop +jobs: + golangci-lint: + runs-on: ubuntu-latest + steps: + - name: Check out code into the Go module directory + uses: actions/checkout@v2 + - name: golangci-lint + uses: reviewdog/action-golangci-lint@v2 + with: + golangci_lint_flags: "--tests=false" diff --git a/.github/workflows/security.yml b/.github/workflows/security.yml new file mode 100644 index 0000000..5491410 --- /dev/null +++ b/.github/workflows/security.yml @@ -0,0 +1,12 @@ +on: [push, pull_request] +name: Security +jobs: + Gosec: + runs-on: ubuntu-latest + steps: + - name: Fetch Repository + uses: actions/checkout@v3 + - name: Run Gosec + uses: securego/gosec@master + with: + args: ./... diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..fcee1e4 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,42 @@ +name: 'Testing' + +on: + workflow_call: + push: + branches: + - master + - develop + pull_request: + branches: + - master + - develop +jobs: + test: + strategy: + matrix: + os: [ubuntu-latest] + go: [1.19] + runs-on: ${{ matrix.os }} + container: golang:${{ matrix.go }}-bullseye + steps: + - name: Checkout code + uses: actions/checkout@v3 + - uses: actions/cache@v2 + with: + path: ~/go/pkg/mod + key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} + restore-keys: | + ${{ runner.os }}-go- + - name: Set up gotestfmt + run: go install github.com/gotesttools/gotestfmt/v2/cmd/gotestfmt@latest + - name: Test ${{ matrix.go }} + run: | + go test -race -covermode=atomic -coverprofile=coverage.txt -timeout 5m -json -v ./... 2>&1 | gotestfmt + - uses: codecov/codecov-action@v1 + with: + token: ${{ secrets.CODECOV_TOKEN }} + file: ./coverage.txt + flags: tests + name: codecov-umbrella + fail_ci_if_error: true + verbose: true diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..485dee6 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..b0f7bd0 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "go.inferGopath": false +} diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..ce92907 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,76 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "GoLibraryTemplate: Race Test", + "type": "shell", + "command": "go", + "args": [ + "test", + "-race", + "-v", + "-covermode=atomic", + "-timeout", + "5m", + "./..." + ], + "group": "test" + }, + { + "label": "GoLibraryTemplate: Test", + "type": "shell", + "command": "go", + "args": [ + "test", + "-v", + "-covermode=atomic", + "-timeout", + "5m", + "./..." + ], + "group": "test" + }, + { + "label": "GoLibraryTemplate: Format", + "type": "shell", + "command": "gofumpt", + "args": [ + "-l", + "-w", + "." + ], + "group": "none", + "problemMatcher": [] + }, + { + "label": "GoLibraryTemplate: Lint", + "type": "shell", + "command": "golangci-lint", + "args": [ + "run" + ], + "group": "none" + }, + { + "label": "GoLibraryTemplate: GoMod Tidy", + "type": "shell", + "command": "go", + "args": [ + "mod", + "tidy" + ], + "group": "none", + "problemMatcher": [] + }, + { + "label": "GoLibraryTemplate: Security Check", + "type": "shell", + "command": "gosec", + "args": [ + "./..." + ], + "group": "none", + "problemMatcher": [] + } + ], +} diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..ac58383 --- /dev/null +++ b/LICENCE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2022 NanoInteractive + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..abcffdc --- /dev/null +++ b/Makefile @@ -0,0 +1,29 @@ +RACE ?= 0 + +.PHONY: test +test: +ifeq ($(RACE), 1) + @CC=gcc CXX=g++ go test ./... -race -covermode=atomic -coverprofile=coverage.txt -timeout 5m +else + @CC=gcc CXX=g++ go test ./... -covermode=atomic -coverprofile=coverage.txt -timeout 1m +endif + +.PHONY: tidy +tidy: + @rm -f go.sum + @go mod tidy + +.PHONY: clean +clean: + @rm -rf ./bin + +.PHONY: lint +lint: + @golangci-lint run + +.PHONY: fmt +fmt: + @gofumpt -l -w . + +gosec: + @gosec ./... diff --git a/README.md b/README.md new file mode 100644 index 0000000..dea623d --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# Go Library Template + +[![Testing](https://github.com/nano-interactive/go-library-template/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/nano-interactive/go-library-template/actions/workflows/test.yml) +[![codecov](https://codecov.io/gh/nano-interactive/go-template-library/branch/master/graph/badge.svg?token=JQTAGQ11DS)](https://codecov.io/gh/nano-interactive/go-template-library) +[![Go Report Card](https://goreportcard.com/badge/github.com/nano-interactive/go-template-library)](https://goreportcard.com/report/github.com/nano-interactive/go-template-library) diff --git a/doc.go b/doc.go new file mode 100644 index 0000000..c18290f --- /dev/null +++ b/doc.go @@ -0,0 +1,2 @@ +// Documentation +package golibrarytemplate diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..85d48d2 --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module github.com/nano-interactive/go-library-template + +go 1.19 diff --git a/main.go b/main.go new file mode 100644 index 0000000..268dfe3 --- /dev/null +++ b/main.go @@ -0,0 +1,7 @@ +package golibrarytemplate + +import "fmt" + +func ExampleFunc() { + fmt.Println("Start Here...") +}