Skip to content

Commit f55bc20

Browse files
authored
fix: Add buf dependency to release process (open-feature#80)
* Add buf to release please Signed-off-by: Michael Beemer <[email protected]> * add buf dependency note Signed-off-by: Michael Beemer <[email protected]>
1 parent 4cc4a52 commit f55bc20

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

Diff for: .github/workflows/release-please.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,15 @@ jobs:
2020
- name: Checkout Repository
2121
if: ${{ steps.release.outputs.releases_created }}
2222
uses: actions/checkout@v2
23+
- uses: bufbuild/[email protected]
24+
with:
25+
version: "1.1.1"
2326
- name: Setup Node
2427
uses: actions/setup-node@v3
2528
if: ${{ steps.release.outputs.releases_created }}
2629
with:
2730
node-version: 16
28-
registry-url: 'https://registry.npmjs.org'
31+
registry-url: "https://registry.npmjs.org"
2932
- name: Build Packages
3033
if: ${{ steps.release.outputs.releases_created }}
3134
run: |

Diff for: libs/providers/flagd/README.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# NodeJS flagd Provider for OpenFeature
22

3-
![Experimental](https://img.shields.io/badge/experimental-breaking%20changes%20allowed-yellow)
3+
![Experimental](https://img.shields.io/badge/experimental-breaking%20changes%20allowed-yellow)
44

55
Flagd is a simple command line tool for fetching and presenting feature flags to services. It is designed to conform to OpenFeature schema for flag definitions. This repository and package provides the client side code for interacting with it via the Open-Feature Node SDK.
66

@@ -14,22 +14,25 @@ $ npm install @openfeature/flagd-provider
1414

1515
Run `nx package providers-flagd` to build the library.
1616

17+
> NOTE: [Buf](https://docs.buf.build/installation) must be installed to build locally.
18+
1719
## Running unit tests
1820

1921
Run `nx test providers-flagd` to execute the unit tests via [Jest](https://jestjs.io).
2022

23+
## Usage
2124

22-
## Usage
25+
The `FlagdProvider` client constructor takes a single optional argument with 3 fields, their default values correspond to the default arguments supplied to the flagd server:
2326

24-
The `FlagdProvider` client constructor takes a single optional argument with 3 fields, their default values correspond to the default arguments supplied to the flagd server:
2527
```
2628
OpenFeature.setProvider(new FlagdProvider({
27-
service: 'grpc',
29+
service: 'grpc',
2830
host: 'localhost',
2931
port: 8080,
3032
}))
3133
```
32-
**service**: "http" | "grpc" *(defaults to http)*
33-
**host**: string *(defaults to "localhost")*
34-
**port**: number *(defaults to 8080)*
35-
**protocol**: "http" | "https" *(defaults to http - only active for http service)*
34+
35+
**service**: "http" | "grpc" _(defaults to http)_
36+
**host**: string _(defaults to "localhost")_
37+
**port**: number _(defaults to 8080)_
38+
**protocol**: "http" | "https" _(defaults to http - only active for http service)_

0 commit comments

Comments
 (0)