Version Packages (#30)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

example/CHANGELOG.md

@@ -0,0 +1,8 @@
+# example
+
+## 0.1.1
+
+### Patch Changes
+
+- Updated dependencies [1822587]
+  - @happykit/flags@3.0.0

example/package.json

@@ -1,6 +1,6 @@
 {
   "name": "example",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "private": true,
   "scripts": {
     "dev": "next dev",

package/CHANGELOG.md

@@ -0,0 +1,64 @@
+# @happykit/flags
+
+## 3.0.0
+
+### Major Changes
+
+- 1822587: BREAKING CHANGE: Configuration overhaul
+
+  ### What
+
+  This release changes HappyKit's configuration approach.
+
+  Previously you had to create a `flags.config.js` file and import it into your `pages/_app.js` and into every middleware that wanted to use feature flags. If you were using your own `AppFlags` type, you also had to pass this type every time you invoked `getFlags()`, `useFlags()` or `getEdgeFlags()`. And the configuration options for client-, server- and edge were mixed together into a single `flags.config.js` file.
+
+  ### Why
+
+  This release replaces the existing configuration approach with a new one. This new approach configuration prepares happykit for upcoming features.
+
+  ### How
+
+  #### 1. Add `flags` folder
+
+  Follow the updated [Setup](https://github.com/happykit/flags/tree/master/package#setup) instructions to create the `flags` folder in your own application, and fill it with.
+
+  After this step, you should have
+
+  - `./flags/config.ts` which exports a configuration
+  - `./flags/client.ts` which exports a `useFlags` function
+  - `./flags/server.ts` which exports a `getFlags` function
+  - `./flags/edge.ts` which exports a `getEdgeFlags` function
+
+  #### 2. Set up absolute imports
+
+  Enable Absolute Imports as described [here](https://github.com/happykit/flags/tree/master/package#absolute-imports).
+
+  #### 3. Adapt your imports
+
+  Then change the application code in your `pages/` folder to use these functions from your `flags/` folder instead of from `@happykit/flags`:
+
+  ```diff
+  - import { useFlags } from "@happykit/flags/client"
+  + import { useFlags } from "flags/client"
+  ```
+
+  ```diff
+  - import { getFlags } from "@happykit/flags/server"
+  + import { getFlags } from "flags/server"
+  ```
+
+  ```diff
+  - import { getEdgeFlags } from "@happykit/flags/edge"
+  + import { getEdgeFlags } from "flags/edge"
+  ```
+
+  _Note that because of the absolute imports we configured in step 2, all imports from `"flags/_"` will use the local flags folder you created in step 1.\*
+
+  #### 4. Delete your old setup
+
+  We can now delete the old setup since we no longer need it
+
+  - delete `flags.config.js`
+  - remove the `flags.config` import from your `pages/_app` file
+    - you might be able to delete the `pages/_app` file if it's not doing anything else anymore
+  - remove the import of `flags.config` from your middleware

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@happykit/flags",
-  "version": "2.0.7",
+  "version": "3.0.0",
   "description": "Feature Flags for Next.js",
   "author": "Dominik Ferber <dominik.ferber+npm@gmail.com> (http://dferber.de/)",
   "license": "MIT",