Skip to content

Commit c77e5d3

Browse files
committed
Merge branch 'main' into feat/context-propagation
2 parents 7fcf7e6 + a0c79d7 commit c77e5d3

File tree

10 files changed

+590
-247
lines changed

10 files changed

+590
-247
lines changed

.github/workflows/pr-checks.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
runs-on: ubuntu-latest
1515

1616
steps:
17-
- uses: actions/checkout@v3
17+
- uses: actions/checkout@v4
1818
- uses: actions/setup-python@v5
1919

2020
- name: Generate JSON files
@@ -34,7 +34,7 @@ jobs:
3434
json-lint:
3535
runs-on: ubuntu-latest
3636
steps:
37-
- uses: actions/checkout@v3
37+
- uses: actions/checkout@v4
3838
- uses: actions/setup-python@v5
3939

4040
- name: Lint
@@ -44,9 +44,9 @@ jobs:
4444
markdown-toc:
4545
runs-on: ubuntu-latest
4646
steps:
47-
- uses: actions/checkout@v3
47+
- uses: actions/checkout@v4
4848
- uses: actions/setup-python@v5
49-
- uses: actions/setup-node@v3
49+
- uses: actions/setup-node@v4
5050
with:
5151
node-version: "18"
5252

.github/workflows/repo-stats.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Uses https://github.com/jgehrcke/github-repo-stats to overcome the 14-day limitation of GitHub's built-in traffic statistics.
2+
name: "Repo Stats"
3+
4+
on:
5+
schedule:
6+
# Run this once per day, towards the end of the day for keeping the most
7+
# recent data point most meaningful (hours are interpreted in UTC).
8+
- cron: "0 23 * * *"
9+
workflow_dispatch: # Allow for running this manually.
10+
11+
jobs:
12+
snapshot:
13+
name: github-repo-stats
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: run-ghrs
17+
# Use latest release.
18+
uses: jgehrcke/[email protected]
19+
with:
20+
databranch: github-repo-stats
21+
ghtoken: ${{ secrets.REPO_STATS_TOKEN }}

README.md

Lines changed: 39 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,55 @@
1-
# OpenFeature Specification
1+
<!-- markdownlint-disable MD033 -->
2+
<!-- x-hide-in-docs-start -->
3+
<p align="center">
4+
<picture>
5+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/white/openfeature-horizontal-white.svg" />
6+
<img align="center" alt="OpenFeature Logo" src="https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/black/openfeature-horizontal-black.svg" />
7+
</picture>
8+
</p>
29

3-
[![Roadmap](https://img.shields.io/static/v1?label=Roadmap&message=public&color=green)](https://github.com/orgs/open-feature/projects/1) [![Contributing](https://img.shields.io/static/v1?label=Contributing&message=guide&color=blue)](https://github.com/open-feature/.github/blob/main/CONTRIBUTING.md) [![Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/open-feature/.github/blob/main/CODE_OF_CONDUCT.md)
10+
<h2 align="center">OpenFeature Specification</h2>
411

5-
This repository describes the requirements and expectations for OpenFeature.
12+
<!-- x-hide-in-docs-end -->
13+
<!-- The 'github-badges' class is used in the docs -->
14+
<p align="center" class="github-badges">
15+
<a href="https://github.com/orgs/open-feature/projects/1">
16+
<img alt="Roadmap" src="https://img.shields.io/static/v1?label=Roadmap&message=public&color=green" />
17+
</a>
18+
<a href="https://github.com/open-feature/.github/blob/main/CONTRIBUTING.md">
19+
<img alt="Contributing" src="https://img.shields.io/static/v1?label=Contributing&message=guide&color=blue" />
20+
</a>
21+
<a href="https://cloud-native.slack.com/archives/C0344AANLA1">
22+
<img alt="Slack" src="https://img.shields.io/badge/slack-%40cncf%2Fopenfeature-brightgreen?style=flat&logo=slack"/>
23+
</a>
24+
<a href="https://bestpractices.coreinfrastructure.org/projects/6601">
25+
<img alt="CII Best Practices" src="https://bestpractices.coreinfrastructure.org/projects/6601/badge" />
26+
</a>
27+
</p>
28+
<!-- x-hide-in-docs-start -->
29+
30+
[OpenFeature](https://openfeature.dev) is an open specification that provides a vendor-agnostic, community-driven API for feature flagging that works with your favorite feature flag management tool or in-house solution.
631

7-
> :warning: Ongoing research can be found in the [research repo](https://github.com/open-feature/research). For definitions of key terminology, see the [glossary](./specification/glossary.md).
32+
This repository describes the requirements and expectations for OpenFeature.
833

934
## Design Principles
1035

11-
- Compatibility with existing feature flag offerings
12-
- Simple, understandable APIs
13-
- Vendor agnosticism
14-
- Language agnosticism
15-
- Low/no dependency
16-
- Extensibility
36+
The OpenFeature specification must be designed with:
37+
38+
- compatibility with existing feature flag offerings.
39+
- simple, understandable APIs.
40+
- vendor agnosticism.
41+
- language agnosticism.
42+
- low/no dependency.
43+
- extensibility.
1744

1845
### SDKs and Client Libraries
1946

20-
The project aims to provide a unified API and SDK for feature flag management in various technology stacks.
47+
The project aims to provide a unified API and SDK feature flag evaluation across popular technology stacks.
2148
The OpenFeature SDK provides a mechanism for interfacing
2249
with an external evaluation engine in a vendor agnostic way;
2350
it does **not** itself handle the flag evaluation logic.
2451

25-
The OpenFeature project will include client libraries for common technology stacks including, but not limited to:
26-
27-
- Golang
28-
- Java
29-
- JavaScript/TypeScript (Node.js)
52+
An up-to-date SDK compatibility overview can be found [here](https://openfeature.dev/docs/reference/technologies/sdk-compatibility).
3053

3154
### Tooling
3255

0 commit comments

Comments
 (0)