diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..d7cce9f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,28 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Environments** +- Version: +- OS: + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/issue.md b/.github/ISSUE_TEMPLATE/issue.md new file mode 100644 index 0000000..8755fcd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue.md @@ -0,0 +1,23 @@ +--- +name: Task +about: Describe this issue +title: '' +labels: '' +assignees: '' + +--- + +## What + +Describe what this issue should address. + +## How + +Describe how to address the issue. + +## Checklist + +- [ ] Finish implementation of the issue +- [ ] Test all functions +- [ ] Have enough logs to trace activities +- [ ] Notify developers of necessary actions diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..e69e833 --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,18 @@ +name: CI +on: + pull_request: + push: + branches: + - 'main' +env: + go-version: "1.20" +jobs: + test: + name: Small tests + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-go@v3 + with: + go-version: ${{ env.go-version }} + - run: make test diff --git a/.github/workflows/mdbook.yaml b/.github/workflows/mdbook.yaml new file mode 100644 index 0000000..6ea5b2c --- /dev/null +++ b/.github/workflows/mdbook.yaml @@ -0,0 +1,49 @@ +name: Book +on: + pull_request: + push: + branches: + - 'main' +jobs: + build: + name: Build book + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v3 + - run: make book + - uses: actions/upload-artifact@v3 + with: + name: book + path: docs/book + retention-days: 1 + publish: + name: Publish book on GitHub Pages + runs-on: ubuntu-22.04 + needs: build + steps: + - uses: actions/checkout@v3 + with: + ref: gh-pages + # do not remove helm chart related files if present + - run: ls | grep -v -E "index.yaml|.*\.tgz" | xargs rm -rf + - uses: actions/download-artifact@v3 + with: + name: book + - run: git add . + - name: Check diff + run: | + diffs=$(git status -s) + if [ "$diffs" = "" ]; then + echo "NO_DIFF=1" >> $GITHUB_ENV + else + printf "%s\n" "$diffs" + fi + - name: Commit changes + if: env.NO_DIFF != '1' + run: | + git config --global user.name 'Cybozu Neco' + git config --global user.email 'cybozu-neco@users.noreply.github.com' + git commit -m 'update' + - name: Push to gh-pages + if: github.ref == 'refs/heads/main' && env.NO_DIFF != '1' + run: git push origin gh-pages diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5ccc268 --- /dev/null +++ b/.gitignore @@ -0,0 +1,20 @@ +# Test binary, build with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736 +.glide/ + +# Editors +*~ +.*.swp +.#* +\#*# +/.vscode +/.idea + +# Generated files +/bin +/docs/book diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9115790 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# Change Log + +All notable changes to this project will be documented in this file. +This project adheres to [Semantic Versioning](http://semver.org/). + +## [Unreleased] + +### Added +### Changed +### Removed + +[Unreleased]: https://github.com/cybozu-go/neco-template/compare/4b825dc642cb6eb9a060e54bf8d69288fbee4904...HEAD diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -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 [yyyy] [name of copyright owner] + + 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..b3695d6 --- /dev/null +++ b/Makefile @@ -0,0 +1,45 @@ +BIN_DIR := $(shell pwd)/bin + +# Tool versions +MDBOOK_VERSION = 0.4.27 +MDBOOK := $(BIN_DIR)/mdbook + +# Test tools +STATICCHECK = $(BIN_DIR)/staticcheck + +.PHONY: all +all: test + +.PHONY: book +book: $(MDBOOK) + rm -rf docs/book + cd docs; $(MDBOOK) build + + +.PHONY: test +test: + if find . -name go.mod | grep -q go.mod; then \ + $(MAKE) test-go; \ + fi + +.PHONY: test-go +test-go: test-tools + test -z "$$(gofmt -s -l . | tee /dev/stderr)" + $(STATICCHECK) ./... + go install ./... + go test -race -v ./... + go vet ./... + + +##@ Tools + +$(MDBOOK): + mkdir -p bin + curl -fsL https://github.com/rust-lang/mdBook/releases/download/v$(MDBOOK_VERSION)/mdbook-v$(MDBOOK_VERSION)-x86_64-unknown-linux-gnu.tar.gz | tar -C bin -xzf - + +.PHONY: test-tools +test-tools: $(STATICCHECK) + +$(STATICCHECK): + mkdir -p $(BIN_DIR) + GOBIN=$(BIN_DIR) go install honnef.co/go/tools/cmd/staticcheck@latest diff --git a/README.md b/README.md new file mode 100644 index 0000000..9545ff2 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +[![GitHub release](https://img.shields.io/github/release/cybozu-go/neco-template.svg?maxAge=60)][releases] +[![CI](https://github.com/cybozu-go/neco-template/actions/workflows/ci.yaml/badge.svg)](https://github.com/cybozu-go/neco-template/actions/workflows/ci.yaml) +[![PkgGoDev](https://pkg.go.dev/badge/github.com/cybozu-go/neco-template?tab=overview)](https://pkg.go.dev/github.com/cybozu-go/neco-template?tab=overview) +[![Go Report Card](https://goreportcard.com/badge/github.com/cybozu-go/neco-template)](https://goreportcard.com/report/github.com/cybozu-go/neco-template) + +Template repository for Neco +============================ + +**Project Status**: Initial development + +## Documentation + +[docs](docs/) directory contains documents about designs and specifications. + +[releases]: https://github.com/cybozu-go/neco-template/releases diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..04953d3 --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +# Template documentation diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..fa24aff --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,9 @@ +# Summary + +[Template](README.md) + +# User manual + +# Developer documents + +- [Release procedure](release.md) diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000..81e19c4 --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,10 @@ +[book] +language = "en" +multilingual = false +src = "." +title = "Template Documentation" + +[output.html] +git-repository-url = "https://github.com/cybozu-go/neco-template" +edit-url-template = "https://github.com/cybozu-go/neco-template/edit/main/docs/{path}" +site-url = "/neco-template/" diff --git a/docs/release.md b/docs/release.md new file mode 100644 index 0000000..5bdd2a8 --- /dev/null +++ b/docs/release.md @@ -0,0 +1,77 @@ +Release procedure +================= + +This document describes how to release a new version. + +## Versioning + +Follow [semantic versioning 2.0.0][semver] to choose the new version number. + +## Prepare change log entries + +Add notable changes since the last release to [CHANGELOG.md](CHANGELOG.md). +It should look like: + +```markdown +(snip) +## [Unreleased] + +### Added +- Implement ... (#35) + +### Changed +- Fix a bug in ... (#33) + +### Removed +- Deprecated `-option` is removed ... (#39) + +(snip) +``` + +## Bump version + +1. Determine a new version number. Then set `VERSION` variable. + + ```console + # Set VERSION and confirm it. It should not have "v" prefix. + $ VERSION=x.y.z + $ echo $VERSION + ``` + +2. Make a branch to release + + ```console + $ git neco dev "bump-$VERSION" + ``` + +3. Edit `CHANGELOG.md` for the new version ([example][]). +4. Commit the change and push it. + + ```console + $ git commit -a -m "Bump version to $VERSION" + $ git neco review + ``` + +5. Merge this branch. +6. Add a git tag to the main HEAD, then push it. + + ```console + # Set VERSION again. + $ VERSION=x.y.z + $ echo $VERSION + + $ git checkout main + $ git pull + $ git tag -a -m "Release v$VERSION" "v$VERSION" + + # Make sure the release tag exists. + $ git tag -ln | grep $VERSION + + $ git push origin "v$VERSION" + ``` + +GitHub actions will build and push artifacts such as container images and +create a new GitHub release. + +[semver]: https://semver.org/spec/v2.0.0.html +[example]: https://github.com/cybozu-go/etcdpasswd/commit/77d95384ac6c97e7f48281eaf23cb94f68867f79