Skip to content

Commit c5b4822

Browse files
SgtPookilidel
andauthored
docs(readme): update release steps (#1963)
* docs(readme): update translations release steps * docs(readme): Releases are 99% automated * docs: manual release dispatch Manual mode introduced in #1974 Co-authored-by: Marcin Rataj <lidel@lidel.org>
1 parent ea4f632 commit c5b4822

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,17 @@ You can read more on how we use Transifex and i18next in this app at [`docs/LOCA
261261

262262
## Releasing
263263

264-
1. Run `tx pull -a` to pull the latest translations from Transifex ([i18n#transifex-101)](https://github.com/ipfs-shipyard/i18n#transifex-101))
264+
1. Check that the [Transifex sync action](https://github.com/ipfs/ipfs-webui/runs/7165373056?check_suite_focus=true) is [successful](https://github.com/ipfs/ipfs-webui/runs/7121497704?check_suite_focus=true) or [fails because there are no updates](https://github.com/ipfs/ipfs-webui/runs/7165373056?check_suite_focus=true).
265+
1. If UI is materially different, update screenshots in `README.md` and on docs.ipfs.io [here](https://docs.ipfs.io/how-to/command-line-quick-start/#web-console)
266+
1. Manually dispatch [ci.yml](https://github.com/ipfs/ipfs-webui/actions/workflows/ci.yml) workflow on `main` branch. This will create a new release.
267+
1. If release is good enough for LTS, update the CID at projects that use ipfs-webui by submitting PR against below lines:
268+
- ~js-ipfs: https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-http-server/src/api/routes/webui.js#L5~
269+
- currently blocked by https://github.com/ipfs/ipfs-webui/issues/1730
270+
- Kubo: https://github.com/ipfs/kubo/blob/master/core/corehttp/webui.go#L4
271+
- IPFS Desktop: https://github.com/ipfs/ipfs-desktop/blob/master/package.json#L18
272+
273+
<!-- DEPRECATED STEPS as of https://github.com/ipfs/ipfs-webui/releases/tag/v2.16.0. Leaving only for posterity:
274+
1. Check that the [Transifex sync action](https://github.com/ipfs/ipfs-webui/runs/7165373056?check_suite_focus=true) is [successful](https://github.com/ipfs/ipfs-webui/runs/7121497704?check_suite_focus=true) or [fails because there are no updates](https://github.com/ipfs/ipfs-webui/runs/7165373056?check_suite_focus=true).
265275
1. If UI is materially different, update screenshots in `README.md` and on docs.ipfs.io [here](https://docs.ipfs.io/how-to/command-line-quick-start/#web-console)
266276
1. Commit changes and ensure everything is merged into `main` branch
267277
1. Update the version (`npm version [major|minor|patch]`, it will create a new tag `vN.N.N`, note it down)
@@ -271,8 +281,9 @@ You can read more on how we use Transifex and i18next in this app at [`docs/LOCA
271281
1. If release is good enough for LTS, update the CID at projects that use ipfs-webui by submitting PR against below lines:
272282
- ~js-ipfs: https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-http-server/src/api/routes/webui.js#L5~
273283
- currently blocked by https://github.com/ipfs/ipfs-webui/issues/1730
274-
- go-ipfs: https://github.com/ipfs/go-ipfs/blob/master/core/corehttp/webui.go#L4
275-
- ipfs-desktop: https://github.com/ipfs/ipfs-desktop/blob/master/package.json#L18
284+
- Kubo: https://github.com/ipfs/kubo/blob/master/core/corehttp/webui.go#L4
285+
- IPFS Desktop: https://github.com/ipfs/ipfs-desktop/blob/master/package.json#L18
286+
-->
276287

277288
## Contribute
278289

0 commit comments

Comments
 (0)