-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Moved logger from dapr/dapr Co-authored-by: Yaron Schneider <[email protected]> Co-authored-by: Artur Souza <[email protected]> Co-authored-by: Mukundan Sundararajan <[email protected]> Co-authored-by: Young Bu Park <[email protected]> Co-authored-by: Sky/敖小剑 <[email protected]> Co-authored-by: Joni Collinge Co-authored-by: Jigar <[email protected]> Co-authored-by: Ben Wells Co-authored-by: yellow chicks <[email protected]>
- Loading branch information
1 parent
93d6b9e
commit 6f1fbfe
Showing
19 changed files
with
1,079 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
name: Bug report | ||
about: Report a bug in Kit | ||
title: '' | ||
labels: kind/bug | ||
assignees: '' | ||
|
||
--- | ||
## Expected Behavior | ||
|
||
<!-- Briefly describe what you expect to happen --> | ||
|
||
|
||
## Actual Behavior | ||
|
||
<!-- Briefly describe what is actually happening --> | ||
|
||
|
||
## Steps to Reproduce the Problem | ||
|
||
<!-- How can a maintainer reproduce this issue (be detailed) --> | ||
|
||
## Release Note | ||
<!-- How should the fix for this issue be communicated in our release notes? It can be populated later. --> | ||
<!-- Keep it as a single line. Examples: --> | ||
|
||
<!-- RELEASE NOTE: **ADD** New feature in Dapr. --> | ||
<!-- RELEASE NOTE: **FIX** Bug in runtime. --> | ||
<!-- RELEASE NOTE: **UPDATE** Runtime dependency. --> | ||
|
||
RELEASE NOTE: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
name: Feature Request | ||
about: Start a discussion for Kit | ||
title: '' | ||
labels: kind/discussion | ||
assignees: '' | ||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: Feature Request | ||
about: Create a Feature Request for Kit | ||
title: '' | ||
labels: kind/enhancement | ||
assignees: '' | ||
|
||
--- | ||
## Describe the feature | ||
|
||
## Release Note | ||
<!-- How should this new feature be announced in our release notes? It can be populated later. --> | ||
<!-- Keep it as a single line. Examples: --> | ||
|
||
<!-- RELEASE NOTE: **ADD** New feature in Dapr. --> | ||
<!-- RELEASE NOTE: **FIX** Bug in runtime. --> | ||
<!-- RELEASE NOTE: **UPDATE** Runtime dependency. --> | ||
|
||
RELEASE NOTE: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
name: Proposal | ||
about: Create a proposal for Kit | ||
title: '' | ||
labels: kind/proposal | ||
assignees: '' | ||
|
||
--- | ||
## Describe the proposal |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
name: Question | ||
about: Ask a question about Kit | ||
title: '' | ||
labels: kind/question | ||
assignees: '' | ||
|
||
--- | ||
## Ask your question here |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Description | ||
|
||
_Please explain the changes you've made_ | ||
|
||
## Issue reference | ||
|
||
We strive to have all PR being opened based on an issue, where the problem or feature have been discussed prior to implementation. | ||
|
||
Please reference the issue this PR will close: #_[issue number]_ | ||
|
||
## Checklist | ||
|
||
Please make sure you've completed the relevant tasks for this PR, out of the following list: | ||
|
||
* [ ] Code compiles correctly | ||
* [ ] Created/updated tests |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# ------------------------------------------------------------ | ||
# Copyright (c) Microsoft Corporation and Dapr Contributors. | ||
# Licensed under the MIT License. | ||
# ------------------------------------------------------------ | ||
|
||
name: kit | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
- release-* | ||
tags: | ||
- v* | ||
pull_request: | ||
branches: | ||
- main | ||
- release-* | ||
jobs: | ||
build: | ||
name: Build ${{ matrix.target_os }}_${{ matrix.target_arch }} binaries | ||
runs-on: ${{ matrix.os }} | ||
env: | ||
GOVER: 1.16 | ||
GOOS: ${{ matrix.target_os }} | ||
GOARCH: ${{ matrix.target_arch }} | ||
GOPROXY: https://proxy.golang.org | ||
GOLANGCI_LINT_VER: v1.31 | ||
strategy: | ||
matrix: | ||
os: [ubuntu-latest, windows-latest, macOS-latest] | ||
target_arch: [arm, amd64] | ||
include: | ||
- os: ubuntu-latest | ||
target_os: linux | ||
- os: windows-latest | ||
target_os: windows | ||
- os: macOS-latest | ||
target_os: darwin | ||
exclude: | ||
- os: windows-latest | ||
target_arch: arm | ||
- os: macOS-latest | ||
target_arch: arm | ||
steps: | ||
- name: Set up Go ${{ env.GOVER }} | ||
uses: actions/setup-go@v1 | ||
with: | ||
go-version: ${{ env.GOVER }} | ||
- name: Check out code into the Go module directory | ||
uses: actions/checkout@v2 | ||
- name: Run golangci-lint | ||
if: matrix.target_arch == 'amd64' && matrix.target_os == 'linux' | ||
uses: golangci/[email protected] | ||
with: | ||
version: ${{ env.GOLANGCI_LINT_VER }} | ||
- name: Run make go.mod check-diff | ||
if: matrix.target_arch != 'arm' | ||
run: make go.mod check-diff | ||
- name: Run make test | ||
env: | ||
COVERAGE_OPTS: "-coverprofile=coverage.txt -covermode=atomic" | ||
if: matrix.target_arch != 'arm' | ||
run: make test | ||
- name: Codecov | ||
if: matrix.target_arch == 'amd64' && matrix.target_os == 'linux' | ||
uses: codecov/codecov-action@v1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# These owners are the maintainers and approvers of this repo | ||
* @maintainers-kit @approvers-kit |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
# Contribution Guidelines | ||
|
||
Thank you for your interest in Dapr! | ||
|
||
This project welcomes contributions and suggestions. Most contributions require you to | ||
agree to a Contributor License Agreement (CLA) declaring that you have the right to, | ||
and actually do, grant us the rights to use your contribution. | ||
|
||
For details, visit https://cla.microsoft.com. | ||
|
||
When you submit a pull request, a CLA-bot will automatically determine whether you need | ||
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the | ||
instructions provided by the bot. You will only need to do this once across all repositories using our CLA. | ||
|
||
This project has adopted the Microsoft Open Source Code of Conduct. | ||
For more information see the Code of Conduct FAQ | ||
or contact [email protected] with any additional questions or comments. | ||
|
||
Contributions come in many forms: submitting issues, writing code, participating in discussions and community calls. | ||
|
||
This document provides the guidelines for how to contribute to the Dapr project. | ||
|
||
## Issues | ||
|
||
This section describes the guidelines for submitting issues | ||
|
||
### Issue Types | ||
|
||
There are 4 types of issues: | ||
|
||
- Issue/Bug: You've found a bug with the code, and want to report it, or create an issue to track the bug. | ||
- Issue/Discussion: You have something on your mind, which requires input form others in a discussion, before it eventually manifests as a proposal. | ||
- Issue/Proposal: Used for items that propose a new idea or functionality. This allows feedback from others before code is written. | ||
- Issue/Question: Use this issue type, if you need help or have a question. | ||
|
||
### Before You File | ||
|
||
Before you file an issue, make sure you've checked the following: | ||
|
||
1. Is it the right repository? | ||
- The Dapr project is distributed across multiple repositories. Check the list of [repositories](https://github.com/dapr) if you aren't sure which repo is the correct one. | ||
1. Check for existing issues | ||
- Before you create a new issue, please do a search in [open issues](https://github.com/dapr/components-contrib/issues) to see if the issue or feature request has already been filed. | ||
- If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reaction-to-pull-requests-issues-and-comments). Use a reaction: | ||
- 👍 up-vote | ||
- 👎 down-vote | ||
1. For bugs | ||
- Check it's not an environment issue. For example, if running on Kubernetes, make sure prerequisites are in place. (state stores, bindings, etc.) | ||
- You have as much data as possible. This usually comes in the form of logs and/or stacktrace. If running on Kubernetes or other environment, look at the logs of the Dapr services (runtime, operator, placement service). More details on how to get logs can be found [here](https://docs.dapr.io/operations/troubleshooting/logs-troubleshooting/). | ||
1. For proposals | ||
- Many changes to the Dapr runtime may require changes to the API. In that case, the best place to discuss the potential feature is the main [Dapr repo](https://github.com/dapr/dapr). | ||
- Other examples could include bindings, state stores or entirely new components. | ||
|
||
## Contributing to Dapr | ||
|
||
This section describes the guidelines for contributing code / docs to Dapr. | ||
|
||
### Pull Requests | ||
|
||
All contributions come through pull requests. To submit a proposed change, we recommend following this workflow: | ||
|
||
1. Make sure there's an issue (bug or proposal) raised, which sets the expectations for the contribution you are about to make. | ||
1. Fork the relevant repo and create a new branch | ||
1. Create your change | ||
- Code changes require tests | ||
1. Update relevant documentation for the change | ||
1. Commit and open a PR | ||
1. Wait for the CI process to finish and make sure all checks are green | ||
1. A maintainer of the project will be assigned, and you can expect a review within a few days | ||
|
||
#### Use work-in-progress PRs for early feedback | ||
|
||
A good way to communicate before investing too much time is to create a "Work-in-progress" PR and share it with your reviewers. The standard way of doing this is to add a "[WIP]" prefix in your PR's title and assign the **do-not-merge** label. This will let people looking at your PR know that it is not well baked yet. | ||
|
||
### Use of Third-party code | ||
|
||
- All third-party code must be placed in the `vendor/` folder. | ||
- `vendor/` folder is managed by Go modules and stores the source code of third-party Go dependencies. - The `vendor/` folder should not be modified manually. | ||
- Third-party code must include licenses. | ||
|
||
A non-exclusive list of code that must be places in `vendor/`: | ||
|
||
- Open source, free software, or commercially-licensed code. | ||
- Tools or libraries or protocols that are open source, free software, or commercially licensed. | ||
|
||
**Thank You!** - Your contributions to open source, large or small, make projects like this possible. Thank you for taking the time to contribute. | ||
|
||
## Code of Conduct | ||
|
||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
# ------------------------------------------------------------ | ||
# Copyright (c) Microsoft Corporation and Dapr Contributors. | ||
# Licensed under the MIT License. | ||
# ------------------------------------------------------------ | ||
|
||
################################################################################ | ||
# Variables # | ||
################################################################################ | ||
|
||
export GO111MODULE ?= on | ||
export GOPROXY ?= https://proxy.golang.org | ||
export GOSUMDB ?= sum.golang.org | ||
|
||
GIT_COMMIT = $(shell git rev-list -1 HEAD) | ||
GIT_VERSION = $(shell git describe --always --abbrev=7 --dirty) | ||
# By default, disable CGO_ENABLED. See the details on https://golang.org/cmd/cgo | ||
CGO ?= 0 | ||
|
||
LOCAL_ARCH := $(shell uname -m) | ||
ifeq ($(LOCAL_ARCH),x86_64) | ||
TARGET_ARCH_LOCAL=amd64 | ||
else ifeq ($(shell echo $(LOCAL_ARCH) | head -c 5),armv8) | ||
TARGET_ARCH_LOCAL=arm64 | ||
else ifeq ($(shell echo $(LOCAL_ARCH) | head -c 4),armv) | ||
TARGET_ARCH_LOCAL=arm | ||
else | ||
TARGET_ARCH_LOCAL=amd64 | ||
endif | ||
export GOARCH ?= $(TARGET_ARCH_LOCAL) | ||
|
||
LOCAL_OS := $(shell uname) | ||
ifeq ($(LOCAL_OS),Linux) | ||
TARGET_OS_LOCAL = linux | ||
else ifeq ($(LOCAL_OS),Darwin) | ||
TARGET_OS_LOCAL = darwin | ||
else | ||
TARGET_OS_LOCAL ?= windows | ||
endif | ||
export GOOS ?= $(TARGET_OS_LOCAL) | ||
|
||
ifeq ($(GOOS),windows) | ||
BINARY_EXT_LOCAL:=.exe | ||
GOLANGCI_LINT:=golangci-lint.exe | ||
# Workaround for https://github.com/golang/go/issues/40795 | ||
BUILDMODE:=-buildmode=exe | ||
else | ||
BINARY_EXT_LOCAL:= | ||
GOLANGCI_LINT:=golangci-lint | ||
endif | ||
|
||
################################################################################ | ||
# Target: test # | ||
################################################################################ | ||
.PHONY: test | ||
test: | ||
go test ./... $(COVERAGE_OPTS) $(BUILDMODE) | ||
|
||
################################################################################ | ||
# Target: lint # | ||
################################################################################ | ||
.PHONY: lint | ||
lint: | ||
# Due to https://github.com/golangci/golangci-lint/issues/580, we need to add --fix for windows | ||
$(GOLANGCI_LINT) run --timeout=20m | ||
|
||
################################################################################ | ||
# Target: go.mod # | ||
################################################################################ | ||
.PHONY: go.mod | ||
go.mod: | ||
go mod tidy | ||
|
||
################################################################################ | ||
# Target: check-diff # | ||
################################################################################ | ||
.PHONY: check-diff | ||
check-diff: | ||
git diff --exit-code ./go.mod # check no changes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,7 @@ | ||
# kit | ||
|
||
Shared utility code for Dapr runtime | ||
|
||
## Code of Conduct | ||
|
||
Please refer to our [Dapr Community Code of Conduct](https://github.com/dapr/community/blob/master/CODE-OF-CONDUCT.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
module github.com/dapr/kit | ||
|
||
go 1.16 | ||
|
||
require ( | ||
github.com/pkg/errors v0.9.1 | ||
github.com/sirupsen/logrus v1.8.1 | ||
github.com/stretchr/testify v1.7.0 | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= | ||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= | ||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= | ||
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= | ||
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= | ||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= | ||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= | ||
github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE= | ||
github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= | ||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= | ||
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= | ||
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= | ||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= | ||
golang.org/x/sys v0.0.0-20191026070338-33540a1f6037 h1:YyJpGZS1sBuBCzLAR1VEpK193GlqGZbnPFnPV/5Rsb4= | ||
golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= | ||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= | ||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= | ||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= | ||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= |
Oops, something went wrong.