Skip to content

Commit

Permalink
- Add Support Policy
Browse files Browse the repository at this point in the history
- Update tests

Closes #66

Signed-off-by: Alex In <[email protected]>
  • Loading branch information
inliquid committed Nov 7, 2024
1 parent 114c625 commit 7f8d580
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 6 deletions.
9 changes: 5 additions & 4 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
- 'LICENSE'
pull_request:
env:
GO_VERSION: "1.20"
GO_VERSION: "1.22"
PROTOC_VERSION: "21.12"

jobs:
Expand All @@ -20,9 +20,10 @@ jobs:
fail-fast: false
matrix:
tinygo-version:
- "0.31.1"
- "0.30.0"
- "0.29.0"
- "0.31.2"
- "0.32.0"
- "0.33.0"
- "0.34.0"

steps:
- uses: actions/checkout@v3
Expand Down
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,23 @@ This architecture has a number of benefits:

Download a binary [here][releases] and put it in `$PATH`.

## Support Policy

`go-plugin` is based on [Wazero][wazero] runtime and has Support Policy which follows [same rules](https://github.com/tetratelabs/wazero/?tab=readme-ov-file#go):
> wazero follows the same version policy as Go's [Release Policy](https://go.dev/doc/devel/release): two versions. wazero will ensure these versions work and bugs are valid if there's an issue with a current Go version.
For example, if current version of Go is `go1.23`, `go-plugin` is ensured to work with Go versions:
- `go1.22`
- `go1.23`

as well as support corresponding `tinygo` versions (having most recent patch versions according to [Semver][semver]):
- `v0.31.2`
- `v0.32.0`
- `v0.33.0`
- `v0.34.0`

Mapping between different versions of Go and TinyGo can be found on [Go compatibility matrix](https://tinygo.org/docs/reference/go-compat-matrix/) and [Releases](https://github.com/tinygo-org/tinygo/releases) page.

## Usage
To use the plugin system, you must take the following steps.
These are high-level steps that must be done.
Expand Down Expand Up @@ -501,4 +518,6 @@ Welcome your contribution :)
[host-functions-example]: https://github.com/knqyf263/go-plugin/tree/main/examples/host-functions
[json-example]: https://github.com/knqyf263/go-plugin/tree/main/tests/host-functions

[releases]: https://github.com/knqyf263/go-plugin/releases
[releases]: https://github.com/knqyf263/go-plugin/releases

[semver]: https://semver.org/
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module github.com/knqyf263/go-plugin

go 1.20
go 1.22

require (
github.com/planetscale/vtprotobuf v0.4.0
Expand Down

0 comments on commit 7f8d580

Please sign in to comment.