Skip to content

Commit

Permalink
feat: rename linkall-labs to vanus-labs (vanus-labs#496)
Browse files Browse the repository at this point in the history
* feat: rename linkall-labs to vanus-labs in observability

Signed-off-by: James Yin <[email protected]>

* feat: rename linkall-labs to vanus-labs in raft

Signed-off-by: James Yin <[email protected]>

* feat: rename linkall-labs to vanus-labs in proto

Signed-off-by: James Yin <[email protected]>

* feat: rename linkall-labs to vanus-labs in pkg

Signed-off-by: James Yin <[email protected]>

* feat: rename linkall-labs to vanus-labs in client

Signed-off-by: James Yin <[email protected]>

* feat: rename linkall-labs to vanus-labs

Signed-off-by: James Yin <[email protected]>

* docs: rename linkall-labs to vanus-labs in url

Signed-off-by: James Yin <[email protected]>

* fix: ci

Signed-off-by: James Yin <[email protected]>

---------

Signed-off-by: James Yin <[email protected]>
  • Loading branch information
ifplusor authored Mar 7, 2023
1 parent 74985f5 commit 786ba49
Show file tree
Hide file tree
Showing 517 changed files with 6,774 additions and 5,835 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Before asking a question, make sure you have:
- Searched existing Stack Overflow questions.
- Googled your question.
- Searched open and closed [GitHub issues](https://github.com/linkall-labs/vanus/issues)
- Searched open and closed [GitHub issues](https://github.com/vanus-labs/vanus/issues)
- Read the documentation:
- [Vanus Readme](https://github.com/linkall-labs/vanus)
- [Vanus Docs](https://github.com/linkall-labs/docs)
- [Vanus Readme](https://github.com/vanus-labs/vanus)
- [Vanus Docs](https://github.com/vanus-labs/docs)
-->
-->
4 changes: 3 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ PR Title Format:
feat/fix/refactor/docs/...: what's changed
Note: see https://github.com/linkall-labs/vanus/blob/main/CONTRIBUTING.md to know details about title format
Note: see https://github.com/vanus-labs/vanus/blob/main/CONTRIBUTING.md to know details about title format
-->

### What problem does this PR solve?

<!--
Please create an issue first to describe the problem
Expand Down
43 changes: 26 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
# How about contributing to Vanus

Thank you for focusing on how to contribute to Vanus, we expect to meet you in Vanus Community. All contributions including:
Thank you for focusing on how to contribute to Vanus, we expect to meet you in Vanus Community. All contributions including:

- submitting an issue
- reviewing the codebase for bugs
- writing documentations
- writing tests
- publishing blogpost about Vanus, are welcomed. Contributions to Vanus project are expected to adhere our
[Code of Conduct](CODE-OF-CONDUCT.md).
- publishing blogpost about Vanus, are welcomed. Contributions to Vanus project are expected to adhere our [Code of Conduct](CODE-OF-CONDUCT.md).

This document outlines some conventions about development workflow, commit message formatting, contact points and other
resources to make it easier to get your contribution accepted.

<!-- TOC -->
- [How about contributing to Vanus](#how-about-contributing-to-vanus)
- [Before you get started](#before-you-get-started)
- [Sign the CLA](#sign-the-cla)
- [Setting up your development environment(optional)](#setting-up-your-development-environmentoptional)
Expand All @@ -27,55 +26,61 @@ resources to make it easier to get your contribution accepted.
- [Testings](#testings)
- [CI Checking](#ci-checking)
- [Code Review](#code-review)
- [Reward](#reward)
<!-- /TOC -->

## Before you get started

### Sign the CLA
Click [here](https://cla-assistant.io/linkall-labs/vanus) to sign the CLA, and click the `Sign in with GitHub to agree` button to sign.

Click [here](https://cla-assistant.io/vanus-labs/vanus) to sign the CLA, and click the `Sign in with GitHub to agree` button to sign.

What is [CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement).

### Setting up your development environment(optional)

If you want to contribute to the codebase of Vanus, it's better to set up a development environment in local first.

1. Install Go version 1.17 or above. Refer to [How to Write Go Code](https://go.dev/doc/code) for more information.
2. Install [minikube](https://minikube.sigs.k8s.io/docs/start/)(Users from China mainland may have network issues that need to be addressed for using minikube).
2. Install [minikube](https://minikube.sigs.k8s.io/docs/start/)(Users from China mainland may have network issues that need to be addressed for using minikube).
Vanus is a k8s based project.
3. Learning [QuickStart](https://docs.linkall.com/getting-started/quick-start) how to deploy the Vanus to k8s. Deploying a specified component to minikube for testing.
3. Learning [QuickStart](https://docs.linkall.com/getting-started/quick-start) how to deploy the Vanus to k8s. Deploying a specified component to minikube for testing.
Click [here](#) for details.

## Issues

After set up is done, the next step is to choose an open issue to address. Issues are all problems of Vanus that need to be addressed.

### Choosing
You can find all open issues in [vanus-issues](https://github.com/linkall-labs/vanus/issues) and choose one which isn't

You can find all open issues in [vanus-issues](https://github.com/vanus-labs/vanus/issues) and choose one which isn't
assigned to someone.

#### First Contribution
You can start by finding existing issues with the
[good-first-issue](https://github.com/linkall-labs/vanus/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue") label.

You can start by finding existing issues with the [good-first-issue](https://github.com/vanus-labs/vanus/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue") label.
These issues are well suited for a new contributor.

#### Further Contributions

After your first contribution is done, you could choose other issues you are interested in to continue contributing. You also
could create a PR directly to Vanus for fixing or improving.

### Submit an Issue

Submitting any issue to Vanus is an important contribution. All issues(bug, feature request, improvement, blog, looking for help, confusing, etc), is ESSENTIAL for making Vanus better.

You could click the `New issue` button in (issues sub-page)[https://github.com/linkall-labs/vanus/issues] of Vanus project to
submit an issue for us.
You could click the `New issue` button in [issues sub-page](https://github.com/vanus-labs/vanus/issues) of Vanus project to submit an issue for us.

## Pull Requests

After your work is done, you can create a `Pull Request` by clicking the `New pull request` button in
[pull requests](https://github.com/linkall-labs/vanus/pulls) page to submit your contribution to Vanus.
[pull requests](https://github.com/vanus-labs/vanus/pulls) page to submit your contribution to Vanus.
More about `Pull Request` you can find [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests).

There are some constraints you need to pay attention to, in order to save reviewer's time.

### Style

We strictly check PR title's style. The PR's title follow [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/)

- feat: A new feature
Expand All @@ -98,21 +103,25 @@ feat: waiting for ack of append from raft
```

### Descriptions
We provide the template for each PR and expect you could explain your PR for what/why/how in detail.

We provide the template for each PR and expect you could explain your PR for what/why/how in detail.
If the PR wants to address one issue, please link to it.

### Testings

We hope you can test well your PR before starting the Code Review. If the PR is about a new feature, refactor or bugfix, the related
Unit tests will be required.

### CI Checking

There are some automated tasks to ensure each PR's reach high quality in Vanus. These tasks are:

- License checker: check if a new source code file includes the 'Apache License 2.0' Header. The auto-generated file isn't required.
- golang-lint: run lint checker to analyze code to find the hidden risk in code.
- CLA checker: checkout if the contributor signed the Contributor License Agreement.
- codecov: run all unit tests and generate unit test report. If any case failed or the coverage number is down, the task will be failed.
- e2e testing: run the e2e testing. Any case that failed will cause the task to failed.

### Code Review
The Code Review can be started until all checking were passed. Each PR will automatically assign reviewers. After getting
at least one `Approve` from reviewers, the PR can be merged.

The Code Review can be started until all checking were passed. Each PR will automatically assign reviewers. After getting at least one `Approve` from reviewers, the PR can be merged.
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@

<div align="center">


<img src="img/vanus-logo.jpg" width="288" >


<!--
<img src="https://user-images.githubusercontent.capabilitiesom/68597908/206148625-43f14f58-f3c0-4042-82a0-9f9421c270fa.png" width="288" >
-->
Expand All @@ -16,22 +13,21 @@ It helps users build event pipelines between SaaS, cloud services, and cloud fun
-->
</p>

[![stars](https://img.shields.io/github/stars/linkall-labs/vanus.svg?style=flat&logo=github&colorB=blueviolet&label=stars)](https://github.com/linkall-labs/vanus)
[![License](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/linkall-labs/vanus/blob/main/LICENSE)
[![codecov](https://codecov.io/gh/linkall-labs/vanus/branch/main/graph/badge.svg?token=RSXSIMEY4V)](https://codecov.io/gh/linkall-labs/vanus)
[![Language](https://img.shields.io/github/go-mod/go-version/linkall-labs/vanus?logo=go)](https://golang.org/)
[![stars](https://img.shields.io/github/stars/vanus-labs/vanus.svg?style=flat&logo=github&colorB=blueviolet&label=stars)](https://github.com/vanus-labs/vanus)
[![License](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/vanus-labs/vanus/blob/main/LICENSE)
[![codecov](https://codecov.io/gh/vanus-labs/vanus/branch/main/graph/badge.svg?token=RSXSIMEY4V)](https://codecov.io/gh/vanus-labs/vanus)
[![Language](https://img.shields.io/github/go-mod/go-version/vanus-labs/vanus?logo=go)](https://golang.org/)
[![playground](https://img.shields.io/badge/Playground-Try%20it%20%20free-red)](https://play.linkall.com)
[![playground](https://img.shields.io/badge/Docs-online-green)](https://linkall.com/docs)


<p>
<a href="https://join.slack.com/t/vanusworkspace/shared_invite/zt-1jilbbfo2-NxiFG0VOo8ABGCCNaeNfcA"><img src="https://img.shields.io/badge/slack-join-3CC798?style=social&logo=slack" height=23></a>
<a href="https://join.slack.com/t/vanusworkspace/shared_invite/zt-1jilbbfo2-NxiFG0VOo8ABGCCNaeNfcA"><img src="https://img.shields.io/badge/slack-join-3CC798?style=social&logo=slack" height=23></a>
&nbsp;
<a href="https://twitter.com/Vanus_dev"><img src="https://img.shields.io/badge/-Twitter-red?style=social&logo=twitter" height=23></a>
<!-- <a href="https://twitter.com/Vanus_dev"><img src="https://img.shields.io/twitter/follow/vanus_dev?style=social" height=23></a> -->
<!-- <a href="https://twitter.com/Vanus_dev"><img src="https://img.shields.io/twitter/follow/vanus_dev?style=social" height=23></a> -->
&nbsp;
<a href="https://www.youtube.com/channel/UC7rd6IgjfNYTOXf2FerFNyA"><img src="https://img.shields.io/badge/-Youtube-red?style=social&logo=youtube" height=23></a>
<!-- <a href="https://www.youtube.com/channel/UC7rd6IgjfNYTOXf2FerFNyA"><img src="https://img.shields.io/youtube/channel/views/UC7rd6IgjfNYTOXf2FerFNyA?style=social" height=23></a> -->
<!-- <a href="https://www.youtube.com/channel/UC7rd6IgjfNYTOXf2FerFNyA"><img src="https://img.shields.io/youtube/channel/views/UC7rd6IgjfNYTOXf2FerFNyA?style=social" height=23></a> -->
&nbsp;
</p>

Expand All @@ -56,16 +52,19 @@ It helps users build event pipelines between SaaS, cloud services, and cloud fun

Vanus helps users build event pipelines between SaaS, cloud services, and cloud functions in minutes.

**1. Build the event-driven system**
### 1. Build the event-driven system

- Get events from cloud services and SaaS, and deliver them to cloud functions or microservices.
- Synchronize changed data or transfer data to the data lake.
- Obtain events generated by SaaS and send them to other SaaS.

**2. Out-of-the-box event computing capabilities**
### 2. Out-of-the-box event computing capabilities

- Real-time processing during event transmissions, such as filtering and transformation.
- Natively support the CloudEvents specification, and can directly send events to workloads that support CloudEvent.

**3. 100% open source, Super easy to use**
### 3. 100% open source, Super easy to use

- One-click deployment, the installation is completed within 1 minute, and developers without MQ experience can also use it.
- Message queues and connectors are 100% open source, a one-stop open-source solution.

Expand All @@ -85,7 +84,7 @@ We have a few channels for contact:

- [Slack](https://join.slack.com/t/vanusworkspace/shared_invite/zt-1jilbbfo2-NxiFG0VOo8ABGCCNaeNfcA)
- [@Vanus_dev](https://twitter.com/Vanus_dev) on Twitter
- [GitHub Issues](https://github.com/linkall-labs/docs/issues)
- [GitHub Issues](https://github.com/vanus-labs/vanus/issues)
- Send emails to: [Vanus](mailto:[email protected])

## How to contribute
Expand Down
4 changes: 2 additions & 2 deletions proto/buf.work.yaml → buf.work.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: v1
directories:
- proto
- include
- proto/proto
- raft
16 changes: 8 additions & 8 deletions client/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//go:generate mockgen -source=client.go -destination=mock_client.go -package=client
//go:generate mockgen -source=client.go -destination=mock_client.go -package=client
package client

import (
// standard libraries
// standard libraries.
"context"
"sync"

// first-party libraries
"github.com/linkall-labs/vanus/observability/tracing"
// first-party libraries.
"github.com/vanus-labs/vanus/observability/tracing"

// this project
eb "github.com/linkall-labs/vanus/client/internal/vanus/eventbus"
"github.com/linkall-labs/vanus/client/pkg/api"
"github.com/linkall-labs/vanus/client/pkg/eventbus"
// this project.
eb "github.com/vanus-labs/vanus/client/internal/vanus/eventbus"
"github.com/vanus-labs/vanus/client/pkg/api"
"github.com/vanus-labs/vanus/client/pkg/eventbus"
)

type Client interface {
Expand Down
10 changes: 5 additions & 5 deletions client/examples/eventbus/append/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ import (
ce "github.com/cloudevents/sdk-go/v2"

// this project.
"github.com/linkall-labs/vanus/client"
"github.com/linkall-labs/vanus/client/pkg/option"
"github.com/linkall-labs/vanus/client/pkg/policy"
"github.com/linkall-labs/vanus/proto/pkg/cloudevents"
"github.com/linkall-labs/vanus/proto/pkg/codec"
"github.com/vanus-labs/vanus/client"
"github.com/vanus-labs/vanus/client/pkg/option"
"github.com/vanus-labs/vanus/client/pkg/policy"
"github.com/vanus-labs/vanus/proto/pkg/cloudevents"
"github.com/vanus-labs/vanus/proto/pkg/codec"
)

func main() {
Expand Down
8 changes: 3 additions & 5 deletions client/examples/eventbus/read/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,10 @@ import (
"context"
"log"

// third-party project.

// this project.
"github.com/linkall-labs/vanus/client"
"github.com/linkall-labs/vanus/client/pkg/option"
"github.com/linkall-labs/vanus/client/pkg/policy"
"github.com/vanus-labs/vanus/client"
"github.com/vanus-labs/vanus/client/pkg/option"
"github.com/vanus-labs/vanus/client/pkg/policy"
)

func main() {
Expand Down
20 changes: 10 additions & 10 deletions client/go.mod
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
module github.com/linkall-labs/vanus/client
module github.com/vanus-labs/vanus/client

go 1.18

require (
github.com/cloudevents/sdk-go/v2 v2.12.0
github.com/cloudevents/sdk-go/v2 v2.13.0
github.com/golang/mock v1.6.0
github.com/linkall-labs/vanus/observability v0.5.7
github.com/linkall-labs/vanus/pkg v0.5.7
github.com/linkall-labs/vanus/proto v0.5.7
github.com/scylladb/go-set v1.0.2
github.com/vanus-labs/vanus/observability v0.5.7
github.com/vanus-labs/vanus/pkg v0.5.7
github.com/vanus-labs/vanus/proto v0.5.7
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.36.4
go.opentelemetry.io/otel/trace v1.11.2
go.uber.org/atomic v1.9.0
google.golang.org/grpc v1.51.0
google.golang.org/protobuf v1.28.1
)

require (
Expand Down Expand Up @@ -43,12 +42,13 @@ require (
golang.org/x/text v0.5.0 // indirect
golang.org/x/time v0.0.0-20220210224613-90d013bbcef8 // indirect
google.golang.org/genproto v0.0.0-20221027153422-115e99e71e1c // indirect
google.golang.org/protobuf v1.28.1 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
)

replace (
github.com/linkall-labs/vanus/observability => ../observability
github.com/linkall-labs/vanus/pkg => ../pkg
github.com/linkall-labs/vanus/proto => ../proto
github.com/linkall-labs/vanus/raft => ../raft
github.com/vanus-labs/vanus/observability => ../observability
github.com/vanus-labs/vanus/pkg => ../pkg
github.com/vanus-labs/vanus/proto => ../proto
github.com/vanus-labs/vanus/raft => ../raft
)
Loading

0 comments on commit 786ba49

Please sign in to comment.