Skip to content

Commit

Permalink
docs(readme): update release steps (#1963)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
SgtPooki and lidel authored Aug 9, 2022
1 parent ea4f632 commit c5b4822
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,17 @@ You can read more on how we use Transifex and i18next in this app at [`docs/LOCA

## Releasing

1. Run `tx pull -a` to pull the latest translations from Transifex ([i18n#transifex-101)](https://github.com/ipfs-shipyard/i18n#transifex-101))
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).
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)
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.
1. If release is good enough for LTS, update the CID at projects that use ipfs-webui by submitting PR against below lines:
- ~js-ipfs: https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-http-server/src/api/routes/webui.js#L5~
- currently blocked by https://github.com/ipfs/ipfs-webui/issues/1730
- Kubo: https://github.com/ipfs/kubo/blob/master/core/corehttp/webui.go#L4
- IPFS Desktop: https://github.com/ipfs/ipfs-desktop/blob/master/package.json#L18

<!-- DEPRECATED STEPS as of https://github.com/ipfs/ipfs-webui/releases/tag/v2.16.0. Leaving only for posterity:
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).
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)
1. Commit changes and ensure everything is merged into `main` branch
1. Update the version (`npm version [major|minor|patch]`, it will create a new tag `vN.N.N`, note it down)
Expand All @@ -271,8 +281,9 @@ You can read more on how we use Transifex and i18next in this app at [`docs/LOCA
1. If release is good enough for LTS, update the CID at projects that use ipfs-webui by submitting PR against below lines:
- ~js-ipfs: https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-http-server/src/api/routes/webui.js#L5~
- currently blocked by https://github.com/ipfs/ipfs-webui/issues/1730
- go-ipfs: https://github.com/ipfs/go-ipfs/blob/master/core/corehttp/webui.go#L4
- ipfs-desktop: https://github.com/ipfs/ipfs-desktop/blob/master/package.json#L18
- Kubo: https://github.com/ipfs/kubo/blob/master/core/corehttp/webui.go#L4
- IPFS Desktop: https://github.com/ipfs/ipfs-desktop/blob/master/package.json#L18
-->

## Contribute

Expand Down

0 comments on commit c5b4822

Please sign in to comment.