Skip to content

Commit

Permalink
Merge pull request #1 from loopholelabs/staging
Browse files Browse the repository at this point in the history
Release v0.5.1
  • Loading branch information
ShivanshVij authored Jul 22, 2022
2 parents 071d538 + 579ebd8 commit d7a8465
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions .trunk/trunk.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
version: 0.1
cli:
version: 0.13.1-beta
version: 0.15.0-beta
lint:
enabled:
- actionlint@1.6.13
Expand All @@ -12,4 +12,4 @@ lint:
ignore:
- linters: [ALL]
paths:
- dist/**
- dist/**
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
[unreleased]: https://github.com/loopholelabs/frpc-go/compare/v0.5.1...HEAD
[v0.5.1]: https://github.com/loopholelabs/frpc-go/releases/tag/v0.5.1
[v0.5.0]: https://github.com/loopholelabs/frisbee-go/compare/v0.4.6...v0.5.0
[v0.5.0]: https://github.com/loopholelabs/frisbee-go/compare/v0.4.6...v0.5.0
2 changes: 1 addition & 1 deletion MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
- Shivansh Vij <shivanshvij@loopholelabs.io> @shivanshvij
- Alex Sørlie Glomsaas <alexsorlieglomsaas@loopholelabs.io> @supermanifolds
- Felicitas Pojtinger <felicitaspojtinger@loopholelabs.io> @pojntfx
- Felicitas Pojtinger <felicitaspojtinger@loopholelabs.io> @pojntfx
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,36 @@
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
[![Tests](https://github.com/loopholelabs/frpc-go/actions/workflows/tests.yaml/badge.svg)](https://github.com/loopholelabs/frpc-go/actions/workflows/tests.yaml)

This is the [Go](http://golang.org) implementation of [fRPC](https://frpc.io), a high-performance RPC framework for
designed for performance and stability, and it uses [frisbee-go](https://github.com/loopholelabs/frisbee) messaging framework under the hood.
This is the [Go](http://golang.org) implementation of [fRPC](https://frpc.io), a high-performance RPC framework for
designed for performance and stability, and it uses [frisbee-go](https://frpc.io/frisbee) messaging framework under the hood.

**This library requires Go1.18 or later.**

## Important note about releases and stability

This repository generally follows [Semantic Versioning](https://semver.org/). However, **this library is currently in
Beta** and is still considered experimental. Breaking changes of the library will _not_ trigger a new major release. The
Alpha** and is still considered experimental. Breaking changes of the library will _not_ trigger a new major release. The
same is true for selected other new features explicitly marked as
**EXPERIMENTAL** in CHANGELOG.md.
**EXPERIMENTAL** in [the changelog](/CHANGELOG.md).

## Usage and Documentation

Usage instructions and documentation for fRPC is available at [https://frpc.io/](https://frpc.io/).

The fRPC Generator is still in very early **Alpha**. While it is functional and being used within other products
The fRPC is still in very early **Alpha**. While it is functional and being used within other products
we're building at [Loophole Labs][loophomepage], the `proto3` spec has a myriad of edge-cases that make it difficult to
guarantee validity of generated RPC frameworks without extensive real-world use.
guarantee validity of generated RPC code without extensive real-world use.

That being said, as the library matures and usage of fRPC grows we'll be able to increase our testing
coverage and fix any edge case bugs. One of the major benefits to the RPC framework is that reading the generated code
coverage and fix any edge cases and bugs. One of the major benefits to the RPC framework is that reading the generated code
is extremely straight forward, making it easy to debug potential issues down the line.

### Unsupported Features

The Frisbee RPC Generator currently does not support the following features, though they are actively being worked on:
fRPC currently does not support the following features, though they are actively being worked on:

- `OneOf` Message Types
- Streaming Messages between the client and server
- `OneOf` Message Types

Example `Proto3` files can be found [here](/examples).

Expand Down
4 changes: 2 additions & 2 deletions pkg/generator/imports.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@ package generator

var (
requiredImports = []string{
"github.com/loopholelabs/frisbee/pkg/packet",
"github.com/loopholelabs/polyglot-go",
"errors",
}

serviceImports = []string{
"github.com/loopholelabs/frisbee",
"github.com/loopholelabs/frisbee-go",
"github.com/rs/zerolog",
"crypto/tls",
"context",
}

methodImports = []string{
"github.com/loopholelabs/frisbee-go/pkg/packet",
"sync",
"sync/atomic",
}
Expand Down

0 comments on commit d7a8465

Please sign in to comment.