Skip to content

Commit 15a68c9

Browse files
committed
feat: improve release process
Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com>
1 parent e6c1901 commit 15a68c9

3 files changed

Lines changed: 189 additions & 211 deletions

File tree

.github/actions/setup/action.yml

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,28 @@ description: 'Set up mise tools (Python, Node.js, ...) and install project depen
44
runs:
55
using: "composite"
66
steps:
7-
- uses: actions/cache@v4
7+
- name: Cache uv .venv
8+
uses: actions/cache@v4
89
with:
9-
path: .venv
10-
key: uv-venv-v1-${{ runner.os }}-${{ hashFiles('uv.lock') }}
11-
restore-keys: uv-venv-v1-${{ runner.os }}-
10+
path: ${{ github.workspace }}/**/.venv
11+
key: uv-venv-v2-${{ runner.os }}-${{ hashFiles('**/uv.lock') }}
12+
restore-keys: uv-venv-v2-${{ runner.os }}-
1213

13-
- uses: actions/cache@v4
14+
- name: Cache pnpm store
15+
uses: actions/cache@v4
1416
with:
1517
path: ~/.local/share/pnpm/store
1618
key: pnpm-store-v1-${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}
1719
restore-keys: pnpm-store-v1-${{ runner.os }}-
20+
21+
- name: Cache Next.js cache
22+
uses: actions/cache@v4
23+
with:
24+
path: ${{ github.workspace }}/**/.next/cache
25+
key: nextjs-cache-v1-${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}-${{ hashFiles('**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx') }}
26+
restore-keys: |
27+
nextjs-cache-v1-${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}-
28+
nextjs-cache-v1-${{ runner.os }}-
1829
1930
- name: Set environment variables
2031
shell: bash

CONTRIBUTING.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -250,9 +250,9 @@ mise x -- telepresence connect
250250
# Receive traffic to a pod by replacing it in the cluster
251251
mise x -- telepresence replace <pod-name>
252252
253-
# More information about how replace/intercept/ingress works can be found in the [Telepresence documentation](https://telepresence.io/docs/howtos/engage).
253+
# More information about how replace/intercept/ingress works: https://telepresence.io/docs/howtos/engage
254+
254255
# Once done, quit Telepresence using:
255-
```sh
256256
mise x -- telepresence quit
257257
```
258258

@@ -328,7 +328,7 @@ This would
328328

329329
### Step 2: QA & Polish the release on release branch
330330

331-
You can then iteratively polish the release in `main` branch and cherry-pick the commits to `release`. When you are ready to create a new release candidate, run `mise run release:bump` to bump up the release candidate version.
331+
You can then iteratively polish the release in `main` branch and cherry-pick the commits to `release`. When you are ready to create a new release candidate, run `mise run release:publish-rc` to bump up the release candidate version.
332332

333333
Creating new RC would trigger GH action to deploy pre-release version of the package for testing.
334334

@@ -337,14 +337,13 @@ Creating new RC would trigger GH action to deploy pre-release version of the pac
337337
Once you've verified the RC version works, publish the final release from the `release` branch:
338338

339339
```shell
340-
git checkout release
341-
mise run release:publish
340+
mise run release:publish-rc
342341
```
343342

344343
This task will simply create a final tag for `release` version and push, which triggers GH action to deploy to pypi and npm.
345344

346345
## Documentation
347346

348-
All changes that modify existing features or introduce new functionality must include documentation updates as part of the pull request. Documentation files should be added or updated in the `docs` folder.
347+
All changes that modify existing features or introduce new functionality must include documentation updates as part of the pull request. Documentation files should be added or updated in the `docs/development` folder.
349348

350349
A GitHub workflow automatically checks that documentation requirements are met. If your change does not require documentation updates (e.g., bug fixes that don't change behavior, internal refactoring, or test-only changes), you must explicitly note this in your PR description.

0 commit comments

Comments
 (0)