Skip to content

Commit

Permalink
chore: 🤖 Add release process documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielmpinto committed May 8, 2024
1 parent b38065f commit 0fcbc46
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,18 @@

# Installation

```
- **npm**

```bash
npm install @fleekxyz/proxy
```

- **pnpm**

```bash
pnpm install @fleekxyz/proxy
```

# Usage

Here's a basic example of a Fleek edge function, demonstrating how to configure and use the proxy package.
Expand All @@ -35,13 +43,29 @@ const proxy = createProxy({
},
});

// Proxy the request and handle the response

export async function main(req: FleekRequest): Promise<FleekResponse> {
return await proxy.proxyRequest(req);
}
```

# Release Process

This project follows SemVer for versioning. Here's how to release a new version:

1. **Update Version Number**: Bump the version number in package.json using npm version (patch/minor/major). This will update the version number in package.json and create a new Git tag.

```bash
pnpm version patch
```

2. **Push Changes and Tags**

```bash
git push origin main --follow-tags
```

3. **GitHub Actions Automation**: A GitHub Actions workflow automatically publishes the package to npm when a new tag is pushed.

# Contributing

Thanks for considering contributing to our project!
Expand Down

0 comments on commit 0fcbc46

Please sign in to comment.