Skip to content

Commit

Permalink
fix: custom release-please plugin for updating versions in readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SgtPooki committed Oct 12, 2023
1 parent dd16b21 commit 7451b0a
Show file tree
Hide file tree
Showing 22 changed files with 1,131 additions and 3,313 deletions.
26 changes: 26 additions & 0 deletions DEVELOPER-NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,31 @@ Manually test a few things that don't transfer well to automated testing:
5. **Mac & Windows (both must to be checked):** Confirm that OS-wide protocol handler was registered by opening <a href="ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi">`ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi`</a> in a stock web browser (Edge, Safari, Google Chrome) _without_ IPFS Companion

### Main release process

PRs are created automatically by release-please and the release is created automatically by CI. The following steps are only needed if you want to manually create a release.

```bash
### Bootstrap release please was used when starting to use release-please, but it's no longer needed (WILL REMOVE)
release-please bootstrap \
--token=$GH_TOKEN \
--repo-url=ipfs/ipfs-desktop \
--release-type=node \
--bump-minor-pre-major=true \
--bump-patch-for-minor-pre-major=true \
--initial-version=v0.31.0
# https://github.com/ipfs/ipfs-desktop/pull/2664

### Create release PR
npm run test-rp-pr

### create github release
npm run test-rp-ghrelease

### When the above PR is merged and github release is created, bump the brew cask version:
brew bump --open-pr homebrew/cask/ipfs

```
<!--
1. Update the version using `npm version [major|minor|patch]` (it will create a new tag `vA.B.C`, note it down)
1. Update all links and badges in `README.md` to point to the new version (`A.B.C`).
- You may use `ts-node scripts/release/updateReadme.ts <oldVersion> <newVersion>` to update the readme. e.g. `ts-node scripts/release/updateReadme.ts 0.26.0 0.26.1`
Expand All @@ -42,6 +67,7 @@ Manually test a few things that don't transfer well to automated testing:
1. Update selected package managers:
- Wait for CI to finish and confirm that it updated [Snap](https://snapcraft.io/ipfs-desktop), and is at least pending review on [Chocolatey](https://chocolatey.org/packages/ipfs-desktop#versionhistory).
- Update the [Homebrew cask](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#updating-a-cask).
-->

### Manually notarize `.dmg` with Apple

Expand Down
13 changes: 1 addition & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai/)
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech/)
[![total download count](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/total.svg?style=flat-square&label=all%20downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases)
<!-- x-release-please-start-version -->
[![latest release download count](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.31.0/total.svg?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/tag/v0.31.0)
<!-- x-release-please-end -->

**IPFS Desktop gives you all the power of [IPFS](https://ipfs.io) in a convenient desktop app: a complete IPFS node, plus handy OS menubar/taskbar shortcuts and an all-in-one file manager, peer map, and content explorer.**

Expand All @@ -21,12 +19,10 @@ Use IPFS Desktop to get acquainted with IPFS without needing to touch the termin

When in doubt, pick one of package formats with built-in automatic update mechanism:

<!-- x-release-please-start-version -->
- **Mac:** [ipfs-desktop-0.31.0-mac.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.31.0/ipfs-desktop-0.31.0-mac.dmg)
- **Windows:** [IPFS-Desktop-Setup-0.31.0.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.31.0/IPFS-Desktop-Setup-0.31.0.exe)
- **Linux:** [ipfs-desktop-0.31.0-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.31.0/ipfs-desktop-0.31.0-linux-x86_64.AppImage)
- If you prefer to manage updates on your own, see [other package formats](#install) below.
<!-- x-release-please-end -->

### Table of Contents

Expand Down Expand Up @@ -115,24 +111,18 @@ Release notes and older versions of IPFS Desktop can be found on the [releases p
Don't see your favorite package manager? Visit our [package managers page](https://github.com/ipfs-shipyard/ipfs-desktop/issues/691) and help us add support for it!

### Mac
<!-- x-release-please-start-version -->
- **Installer:** [ipfs-desktop-0.31.0-mac.dmg](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.31.0/ipfs-desktop-0.31.0-mac.dmg)\
[![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.31.0/ipfs-desktop-0.31.0-mac.dmg.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.31.0/ipfs-desktop-0.31.0-mac.dmg)
- **Homebrew** (community-maintained): `brew install --cask ipfs`
<!-- x-release-please-end -->

### Windows
<!-- x-release-please-start-version -->
- **Installer:** [IPFS-Desktop-Setup-0.31.0.exe](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.31.0/IPFS-Desktop-Setup-0.31.0.exe)\
[![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.31.0/IPFS-Desktop-Setup-0.31.0.exe.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.31.0/IPFS-Desktop-Setup-0.31.0.exe)
- **Chocolatey** (community-maintained): `choco install ipfs-desktop`
- **Scoop** (community-maintained): `scoop bucket add extras; scoop install extras/ipfs-desktop`
- **WinGet** (community-maintained): `winget install IPFS.IPFS-Desktop`
<!-- x-release-please-end -->

### Linux/FreeBSD

<!-- x-release-please-start-version -->
- **AppImage**: [ipfs-desktop-0.31.0-linux-x86_64.AppImage](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.31.0/ipfs-desktop-0.31.0-linux-x86_64.AppImage)\
[![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.31.0/ipfs-desktop-0.31.0-linux-x86_64.AppImage.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.31.0/ipfs-desktop-0.31.0-linux-x86_64.AppImage)
- **Tarball** (use this for building packages for distros): [ipfs-desktop-0.31.0-linux-x64.tar.xz](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.31.0/ipfs-desktop-0.31.0-linux-x64.tar.xz)\
Expand All @@ -144,7 +134,6 @@ Don't see your favorite package manager? Visit our [package managers page](https
- **FreeBSD** (experimental): [ipfs-desktop-0.31.0-linux-x64.freebsd](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.31.0/ipfs-desktop-0.31.0-linux-x64.freebsd) (requires [Linux Binary Compatibility to be enabled](https://docs.freebsd.org/en/books/handbook/linuxemu/))\
[![](https://img.shields.io/github/downloads/ipfs-shipyard/ipfs-desktop/v0.31.0/ipfs-desktop-0.31.0-linux-x64.freebsd.svg?style=flat-square&label=downloads)](https://github.com/ipfs-shipyard/ipfs-desktop/releases/download/v0.31.0/ipfs-desktop-0.31.0-linux-x64.freebsd)
- **Snapcraft** support is deprecated and discouraged due to [confinement issues](https://github.com/ipfs/ipfs-desktop/issues/2031), use `.AppImage` instead
<!-- x-release-please-end -->

Additional third-party packages exist, but have the built-in auto-update mechanism disabled.
Instead, update cycle is maintained by respective communities:
Expand All @@ -171,7 +160,7 @@ npm start
IPFS Desktop in itself is a simple container that makes sure Kubo and IPFS Webui can work together in a standalone fashion and has access to other os-specfic features like tray and contextual integrations.
There are multiple ways to access IPFS Webui:

- https://webui.ipfs.io/#/welcome
- http://127.0.0.1:5001/webui (shipped with kubo)
- IPFS Desktop itself
Expand Down
Loading

0 comments on commit 7451b0a

Please sign in to comment.