From 26b8db0be828d1fc8c903b2e77a69e2b21d0d9f7 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Mon, 12 Oct 2020 12:41:38 -0600 Subject: [PATCH] docs: updates for 0.13.2 (#1681) * docs: changelog update for 0.13.1 * docs: readme version bump * Add manual check info; npm build -> npm run-script build * Bump to 0.13.2, add changelog to release tasks * Make changelog consistent with release notes circa 0.13.2 * docs: protocol handler test scenario License: MIT Signed-off-by: Marcin Rataj * Update README.md Co-authored-by: Marcin Rataj Co-authored-by: Marcin Rataj --- CHANGELOG.md | 30 +++++++++++++++++++++++++++--- README.md | 30 ++++++++++++++++++------------ 2 files changed, 45 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3b3a1a1c5..ec18a4d48 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,13 +3,33 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [v0.13.0] - 2020-10-07 +## [v0.13.2] - 2020-10-12 - Web UI: [`v2.11.4`](https://github.com/ipfs-shipyard/ipfs-webui/releases/v2.11.4) - IPFS: [`go-ipfs v0.7.0`](https://github.com/ipfs/go-ipfs/releases/tag/v0.7.0) ### ✨ Features -- webui v2.11.4 -- go-ipfs v0.7.0 (#1638) +- Use `dweb.link` gateway when shareable link is copied to clipboard +- Preserve filename when a single file is shared (screenshot, quick import) + +### 🛠 Fixes and Maintenance +- fix: windows auto-update (#1679) +- feat(ci): automated Snapcraft publishing (#1678) +- fix: openItem errors (#1687) +- feat: screenshot improvements (#1689) +- fix: OS integrations for quick file import (#1691) +- fix(windows): autoInstallOnAppQuit (#1682) + +## [v0.13.1] - 2020-10-12 +This release is exactly the same as [v0.13.2]. +It exists so people can test Windows autoupdate fix on their own. + +## [v0.13.0] - 2020-10-08 +- Web UI: [`v2.11.4`](https://github.com/ipfs-shipyard/ipfs-webui/releases/v2.11.4) +- IPFS: [`go-ipfs v0.7.0`](https://github.com/ipfs/go-ipfs/releases/tag/v0.7.0) + +### ✨ Features +- webui v2.11.4 ([RELEASE NOTES](https://github.com/ipfs-shipyard/ipfs-webui/releases/tag/v2.11.4)) +- go-ipfs v0.7.0 ([CHANGELOG](https://github.com/ipfs/go-ipfs/blob/master/CHANGELOG.md#v070-2020-09-22)) - synchronized and added new locales ### 🛠 Fixes and Maintenance @@ -18,6 +38,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - fix: uppercase Discovery.MDNS.enabled in default config (#1632) - ci: move to GitHub Actions (#1657) +### 📣 Windows updates may be delayed +Windows 10 users may need to wait a bit longer to see this release. +We are working on a fix. + ## [v0.12.2] - 2020-07-17 - Web UI: [`v2.10.2`](https://github.com/ipfs-shipyard/ipfs-webui/releases/v2.10.2) - IPFS: [`go-ipfs v0.6.0`](https://github.com/ipfs/go-ipfs/releases/tag/v0.6.0) diff --git a/README.md b/README.md index 4479c44dc..eb8561abd 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ **Download the latest release** -- Mac - [IPFS-Desktop-0.13.0.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/IPFS-Desktop-0.13.0.dmg) or `brew cask install ipfs` -- Windows - [IPFS-Desktop-Setup-0.13.0.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/IPFS-Desktop-Setup-0.13.0.exe) or `choco install ipfs-desktop` +- Mac - [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) or `brew cask install ipfs` +- Windows - [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) or `choco install ipfs-desktop` - Linux - see the [install](#install) section for available options ![IPFS Desktop](https://gateway.ipfs.io/ipfs/QmbT2YtuNo17Qaq31FJWRZgRMY4E6N9cdfBwzZTFSHUoBP) @@ -17,7 +17,7 @@ [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) [![](https://david-dm.org/ipfs-shipyard/ipfs-desktop.svg?style=flat-square)](https://david-dm.org/ipfs-shipyard/ipfs-desktop) [![total download count](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/total.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases) -[![latest release download count](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.0/total.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/tag/v0.13.0) +[![latest release download count](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/total.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/tag/v0.13.2) IPFS Desktop allows you to run your IPFS Node on your machine without having to bother with command line tools. With it, you have the power of [Web UI](https://github.com/ipfs-shipyard/ipfs-webui) on tip of your hands plus a handful of shortcuts you can find on settings. @@ -69,18 +69,18 @@ Download the latest release of IPFS Desktop for your OS, below. | Platform | Download link | Download count |---------:|---------------|--------------- -| **Windows** | [IPFS-Desktop-Setup-0.13.0.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/IPFS-Desktop-Setup-0.13.0.exe) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.0/IPFS-Desktop-Setup-0.13.0.exe.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/IPFS-Desktop-Setup-0.13.0.exe) -| **Mac** | [IPFS-Desktop-0.13.0.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/IPFS-Desktop-0.13.0.dmg) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.0/IPFS-Desktop-0.13.0.dmg.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/IPFS-Desktop-0.13.0.dmg) +| **Windows** | [IPFS-Desktop-Setup-0.13.2.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-Setup-0.13.2.exe) +| **Mac** | [IPFS-Desktop-0.13.2.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/IPFS-Desktop-0.13.2.dmg.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/IPFS-Desktop-0.13.2.dmg) We provide multiple _experimental_ installers for **Linux** and **FreeBSD**: | Package | Download link | Download count |---------:|---------------|--------------- -| tar | [ipfs-desktop-0.13.0-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/ipfs-desktop-0.13.0-linux-x64.tar.xz) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.0/ipfs-desktop-0.13.0-linux-x64.tar.xz.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/ipfs-desktop-0.13.0-linux-x64.tar.xz) -| deb | [ipfs-desktop-0.13.0-linux-amd64.deb](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/ipfs-desktop-0.13.0-linux-amd64.deb) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.0/ipfs-desktop-0.13.0-linux-amd64.deb.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/ipfs-desktop-0.13.0-linux-amd64.deb) -| rpm | [ipfs-desktop-0.13.0-linux-x86_64.rpm](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/ipfs-desktop-0.13.0-linux-x86_64.rpm) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.0/ipfs-desktop-0.13.0-linux-x86_64.rpm.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/ipfs-desktop-0.13.0-linux-x86_64.rpm) -| AppImage | [ipfs-desktop-0.13.0-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/ipfs-desktop-0.13.0-linux-x86_64.AppImage) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.0/ipfs-desktop-0.13.0-linux-x86_64.AppImage.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/ipfs-desktop-0.13.0-linux-x86_64.AppImage) -| freebsd | [ipfs-desktop-0.13.0-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/ipfs-desktop-0.13.0-linux-x64.freebsd) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.0/ipfs-desktop-0.13.0-linux-x64.freebsd.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.0/ipfs-desktop-0.13.0-linux-x64.freebsd) +| tar | [ipfs-desktop-0.13.2-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.tar.xz) +| deb | [ipfs-desktop-0.13.2-linux-amd64.deb](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-amd64.deb) +| rpm | [ipfs-desktop-0.13.2-linux-x86_64.rpm](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.rpm) +| AppImage | [ipfs-desktop-0.13.2-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x86_64.AppImage) +| freebsd | [ipfs-desktop-0.13.2-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) | [![](https://img.shields.io/github/downloads-pre/ipfs-shipyard/ipfs-desktop/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.13.2/ipfs-desktop-0.13.2-linux-x64.freebsd) Or you can use your favorite package manager and a third-party package maintained by the community: @@ -105,7 +105,7 @@ Then follow the steps below to clone the source code, install the dependencies a git clone https://github.com/ipfs-shipyard/ipfs-desktop.git cd ipfs-desktop npm ci -npm build +npm run build npm start ``` @@ -118,6 +118,11 @@ Other languages are periodically pulled from [Transifex](https://www.transifex.c ## Releasing +- Manually test a few things that don't transfer well to automated testing: + - Mac/Win/Linux: confirm that "Take Screenshot" under menubar/system tray menu works as expected for both single- and multi-monitor setups (file(s) imported, correct link copied to clipboard) + - Mac only: drag/drop onto menubar icon behaves as expected when dragging one file, several files, and a combination of files/folders (file(s) imported, correct link copied to clipboard) + - Win only: right-click on a file and "Add to IPFS" from context menu works as expected (file imported, correct link copied to clipboard) + - Mac/Win: confirm that OS-wide protocol handler got registered by opening `ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi` in user agent without IPFS Companion - Fetch new translations from Transifex: `tx pull -a` - Commit the changes - Bump the version in `package.json` @@ -128,7 +133,8 @@ Other languages are periodically pulled from [Transifex](https://www.transifex.c - Publish release draft. - Once a release is published, users should receive the app update. See: https://www.electron.build/auto-update. - The `latest.yml, latest-mac.yml, latest-linux.yml` files on the release are used by the app to determine when an app update is available. -- Update links and badges in `README` to point to the new version (`A.B.C`) +- Update links and badges in `README.md` to point to the new version (`A.B.C`) +- Update `CHANGELOG.md` with details from release/release draft - Update selected package managers - Wait for Github Action to finish and confirm it updated [Snap](https://snapcraft.io/ipfs-desktop). - Update [Homebrew Cask](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#updating-a-cask).