From 48a5ce541224d095efaf1bbc2a2eba4f75f0766a Mon Sep 17 00:00:00 2001 From: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com> Date: Tue, 5 Jul 2022 10:15:56 -0700 Subject: [PATCH 1/6] docs(readme): resolve whitespace issues --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4c813f1f0..a319fa8ad 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ | Files | Explore | Peers | Settings | |-------|---------|-------|----------| -| ![Screenshot of the file browser page](docs/screenshots/ipfs-webui-files.png) | ![Screenshot of the IPLD explorer page](docs/screenshots/ipfs-webui-explore.png) | ![Screenshot of the swarm peers map](docs/screenshots/ipfs-webui-peers.png) | ![Screenshot of the settings page](docs/screenshots/ipfs-webui-settings.png) | +| ![Screenshot of the file browser page](docs/screenshots/ipfs-webui-files.png) | ![Screenshot of the IPLD explorer page](docs/screenshots/ipfs-webui-explore.png) | ![Screenshot of the swarm peers map](docs/screenshots/ipfs-webui-peers.png) | ![Screenshot of the settings page](docs/screenshots/ipfs-webui-settings.png) | [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg)](https://protocol.ai/) [![](https://img.shields.io/github/release/ipfs/ipfs-webui.svg)](https://github.com/ipfs/ipfs-webui/releases/latest) [![i18n status](https://img.shields.io/badge/i18n-translated-blue.svg)](https://www.transifex.com/ipfs/ipfs-webui/) [![](https://img.shields.io/badge/matrix%20chat-%23lobby:ipfs.io-blue.svg?style=flat-square)](https://matrix.to/#/#lobby:ipfs.io) @@ -157,7 +157,7 @@ CI setup of ipfs-webui repo runs tests against both JS and GO implementations: It is possible to test against arbitrary versions by tweaking `ipfs` (js-ipfs) and `go-ipfs` in `devDependencies` section of `package.json` and applying the change via `npm i` - + One can also override the binary used in e2e tests by providing a path to an alternative one via `IPFS_GO_EXEC` (or `IPFS_JS_EXEC`): ```sh @@ -268,10 +268,10 @@ You can read more on how we use Transifex and i18next in this app at [`docs/LOCA 1. Update the version (`npm version [major|minor|patch]`, it will create a new tag `vN.N.N`, note it down) 1. Push `main` branch and the `vN.N.N` tag to GitHub: `git push && git push origin vN.N.N` 1. Wait for `vN.N.N` to [build on CI](https://github.com/ipfs/ipfs-webui/actions), and grab the CID produced from the tagged commit -1. Add release notes to https://github.com/ipfs/ipfs-webui/releases, use the tag and CID you created +1. Add release notes to https://github.com/ipfs/ipfs-webui/releases, use the tag and CID you created 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 + - 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 From a6dfdd08d1f07c91a3839b5edb84463336b593de Mon Sep 17 00:00:00 2001 From: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com> Date: Tue, 5 Jul 2022 10:16:34 -0700 Subject: [PATCH 2/6] docs(readme): update translations release steps --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a319fa8ad..e21b5b6f6 100644 --- a/README.md +++ b/README.md @@ -262,7 +262,7 @@ 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. 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) From f284f383d43c821abfbf23eeb12251092b038318 Mon Sep 17 00:00:00 2001 From: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com> Date: Fri, 8 Jul 2022 12:17:30 -0700 Subject: [PATCH 3/6] docs(readme): Releases are 99% automated --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index e21b5b6f6..af525dbe9 100644 --- a/README.md +++ b/README.md @@ -262,6 +262,15 @@ You can read more on how we use Transifex and i18next in this app at [`docs/LOCA ## Releasing +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. 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 + + ## Contribute From 09946fef9d4cf88366884737b4f6b59cefd9c530 Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Tue, 9 Aug 2022 21:40:02 +0200 Subject: [PATCH 4/6] docs: manual release dispatch Manual mode introduced in https://github.com/ipfs/ipfs-webui/pull/1974 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index af525dbe9..1af242cc6 100644 --- a/README.md +++ b/README.md @@ -264,6 +264,7 @@ You can read more on how we use Transifex and i18next in this app at [`docs/LOCA 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 From 8e668ad88bb1df36f8da2f07d33ac0e9d1d8bba6 Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Tue, 9 Aug 2022 21:42:03 +0200 Subject: [PATCH 5/6] chore: kubo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1af242cc6..1154a23ec 100644 --- a/README.md +++ b/README.md @@ -282,8 +282,8 @@ 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 From 2a4e81af9b550604ef09012b63fa6c458acfa8bc Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Tue, 9 Aug 2022 21:43:19 +0200 Subject: [PATCH 6/6] chore: kubo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1154a23ec..217da6a33 100644 --- a/README.md +++ b/README.md @@ -268,8 +268,8 @@ 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