Skip to content

Commit

Permalink
docs(release): bump library version
Browse files Browse the repository at this point in the history
Update library version references from v6 to v7.
  • Loading branch information
TheEdoRan committed Feb 3, 2024
1 parent 864c921 commit e768ace
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 8 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ https://github.com/TheEdoRan/next-safe-action/assets/1337629/7ebc398e-6c7d-49b2-

## Documentation

**Explore the documentation for version 6 of the library on the [next-safe-action website](https://next-safe-action.dev).**
**Explore the documentation for version 7 of the library on the [next-safe-action website](https://next-safe-action.dev).**

If you are looking for old versions documentation, check out:
- the [README_v3](packages/next-safe-action/README_v3.md) file for version 3.x.x.
Expand Down Expand Up @@ -55,6 +55,10 @@ Version 5.x.x of the library is required for Next.js >= 14 applications. Please

Version 6.x.x of the library lets you use validation libraries other than Zod. Please check out the [v5 to v6 migration guide](https://next-safe-action.dev/docs/migration-from-v5-to-v6) on the website for more information.

---

Version 7.x.x of the library supports form actions and improves validation errors handling. Please check out the [v6 to v7 migration guide](https://next-safe-action.dev/docs/migration-from-v6-to-v7) on the website for more information.

## Example

You can find a basic working implementation of the library [here](packages/example-app).
Expand Down
8 changes: 6 additions & 2 deletions packages/next-safe-action/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Documentation

**Explore the documentation for version 6 of the library on [next-safe-action website](https://next-safe-action.dev).**
**Explore the documentation for version 7 of the library on [next-safe-action website](https://next-safe-action.dev).**

## Next.js >= 14 vs 13

Expand All @@ -28,4 +28,8 @@ Version 5.x.x of the library is required for Next.js >= 14 applications. Please

---

Version 6.x.x of the library lets you use validation libraries other than Zod. Please check out the [v5 to v6 migration guide](https://next-safe-action.dev/docs/migration-from-v5-to-v6) on the website for more information.
Version 6.x.x of the library lets you use validation libraries other than Zod. Please check out the [v5 to v6 migration guide](https://next-safe-action.dev/docs/migration-from-v5-to-v6) on the website for more information.

---

Version 7.x.x of the library supports form actions and improves validation errors handling. Please check out the [v6 to v7 migration guide](https://next-safe-action.dev/docs/migration-from-v6-to-v7) on the website for more information.
2 changes: 1 addition & 1 deletion website/docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 11
sidebar_position: 12
description: Learn how to contribute to next-safe-action via GitHub.
---

Expand Down
6 changes: 3 additions & 3 deletions website/docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
sidebar_position: 2
description: Getting started with next-safe-action version 5.
description: Getting started with next-safe-action version 7.
---

# Getting started

:::note
This is the documentation for the current version of the library (6.x.x).
This is the documentation for the current version of the library (7.x.x).
:::

:::info Requirements
Expand Down Expand Up @@ -38,7 +38,7 @@ npm i next-safe-action@v4 zod
## Usage

:::note
If you're still using Next.js 13, you need to enable `serverActions` flag under the `experimental` object in next.config.js file. Find out more [here](/docs/migration-from-v4-to-v5).
If you're still using Next.js 13 with next-safe-action v4, you need to enable `serverActions` flag under the `experimental` object in next.config.js file. Find out more [here](/docs/migration-from-v4-to-v5).
:::

### 1. Instantiate a new client
Expand Down
14 changes: 14 additions & 0 deletions website/docs/migration-from-v6-to-v7.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
sidebar_position: 11
description: Learn how to migrate from next-safe-action version 6 to version 7.
---

# Migration from v6 to v7

## What's new?

WIP

## BREAKING CHANGES

WIP
2 changes: 1 addition & 1 deletion website/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ body {
}

.navbar__brand::after {
content: "v6";
content: "v7";
margin-left: 0.5rem;
font-weight: 500;
position: relative;
Expand Down

0 comments on commit e768ace

Please sign in to comment.