From 9a45ea89fd2facfd1980389ea24416cc564632af Mon Sep 17 00:00:00 2001 From: DeeDeeG Date: Thu, 18 Jul 2024 11:11:48 -0400 Subject: [PATCH 1/4] Tweak wording for the "Manual download" info on the download page --- docs/download.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/download.md b/docs/download.md index 24cdd2109..6c617c832 100644 --- a/docs/download.md +++ b/docs/download.md @@ -190,28 +190,32 @@ You can bypass this by clicking "More info" then "Run anyway". ## Manual download Binaries are built from a number of different branches and PRs but you should -stick to the **master** branch releases for the most stable ones unless you know +stick to the **`master`** branch releases for the most stable ones unless you know exactly what you are looking for. We currently build on both GitHub Actions and Cirrus CI: - GitHub Actions is used for building the majority of our binaries and builds are run on every commit or PR. - - Direct artifact download is available only for those with at least read - permission on the repository. All artifacts are therefore automatically - uploaded to the [pulsar-edit/pulsar-rolling-releases](https://github.com/pulsar-edit/pulsar-rolling-releases/releases) + - Direct artifact download is available only for those who are logged in + with their GitHub accounts. All artifacts from the `master` branch + are therefore automatically uploaded to the [pulsar-edit/pulsar-rolling-releases](https://github.com/pulsar-edit/pulsar-rolling-releases/releases) repository for access by anyone. - Cirrus CI is _only_ used for building Apple silicon (macOS M1/M2) and ARM Linux binaries. These are run less frequently (every Monday, Wednesday, and Friday). -To download a binary produced by GitHub Actions then follow the below steps: +To download a binary produced by GitHub Actions, follow the below steps: - Navigate to the [pulsar-edit/pulsar-rolling-releases](https://github.com/pulsar-edit/pulsar-rolling-releases/releases) releases. - Select the most recent release (or for a specific release reference the timestamp part of the version e.g. 1.109.**2023091606**). - - Most binaries will be available with every release but Apple silicon and - ARM Linux binaries will not. You may need to look for earlier releases. + - x86_64 binaries will be grouped together for most releases, + but occasionally they will be split across multiple releases. + Apple silicon and ARM Linux binaries are usually grouped together + in their own separate release from the x64 binaries, but sometimes not. + You may need to look through the earlier releases + to find binaries for your platform. - Choose the binary you wish to download from the `Assets` section (you may need click the `Show all x assets` link to display them all). See below for descriptions of all available binaries. From cff15da9aaa0d5ef9fcf4d5602d6bb813c79b72c Mon Sep 17 00:00:00 2001 From: DeeDeeG Date: Fri, 19 Jul 2024 17:36:04 -0400 Subject: [PATCH 2/4] download: Apply suggested revision from Daeraxa during PR review Co-authored-by: Daeraxa <58074586+Daeraxa@users.noreply.github.com> --- docs/download.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/download.md b/docs/download.md index 6c617c832..db0e12e1d 100644 --- a/docs/download.md +++ b/docs/download.md @@ -212,10 +212,9 @@ To download a binary produced by GitHub Actions, follow the below steps: part of the version e.g. 1.109.**2023091606**). - x86_64 binaries will be grouped together for most releases, but occasionally they will be split across multiple releases. - Apple silicon and ARM Linux binaries are usually grouped together - in their own separate release from the x64 binaries, but sometimes not. - You may need to look through the earlier releases - to find binaries for your platform. + Apple silicon and ARM Linux binaries are usually, but not always, + grouped together in their own separate release. You may need to look through + the earlier releases to find binaries for your platform. - Choose the binary you wish to download from the `Assets` section (you may need click the `Show all x assets` link to display them all). See below for descriptions of all available binaries. From 085be2254ed7b88f98d743d05c5a8f7a19cd3fff Mon Sep 17 00:00:00 2001 From: DeeDeeG Date: Fri, 19 Jul 2024 17:40:57 -0400 Subject: [PATCH 3/4] Bigger revamp of the "Manual Download" instructions --- docs/download.md | 44 ++++++++++++++++++++++++++++++++------------ 1 file changed, 32 insertions(+), 12 deletions(-) diff --git a/docs/download.md b/docs/download.md index db0e12e1d..48b959888 100644 --- a/docs/download.md +++ b/docs/download.md @@ -193,18 +193,8 @@ Binaries are built from a number of different branches and PRs but you should stick to the **`master`** branch releases for the most stable ones unless you know exactly what you are looking for. -We currently build on both GitHub Actions and Cirrus CI: - -- GitHub Actions is used for building the majority of our binaries and builds - are run on every commit or PR. - - Direct artifact download is available only for those who are logged in - with their GitHub accounts. All artifacts from the `master` branch - are therefore automatically uploaded to the [pulsar-edit/pulsar-rolling-releases](https://github.com/pulsar-edit/pulsar-rolling-releases/releases) - repository for access by anyone. -- Cirrus CI is _only_ used for building Apple silicon (macOS M1/M2) and ARM - Linux binaries. These are run less frequently (every Monday, Wednesday, and Friday). - -To download a binary produced by GitHub Actions, follow the below steps: +For the most convenient access to these recommended binaries +from the `master` branch, please visit our Rolling Releases repository on GitHub: - Navigate to the [pulsar-edit/pulsar-rolling-releases](https://github.com/pulsar-edit/pulsar-rolling-releases/releases) releases. @@ -219,6 +209,36 @@ To download a binary produced by GitHub Actions, follow the below steps: click the `Show all x assets` link to display them all). See below for descriptions of all available binaries. +We currently build on both GitHub Actions and Cirrus CI: + +- GitHub Actions is used for building the majority of our binaries and builds + are run on every commit or PR. + - Direct artifact download is available only for those who are logged in + with their GitHub accounts. + - All artifacts from the `master` branch + are therefore automatically uploaded to the [pulsar-edit/pulsar-rolling-releases](https://github.com/pulsar-edit/pulsar-rolling-releases/releases) + repository for convenient access by anyone. +- Cirrus CI is _only_ used for building Apple silicon (macOS M1/M2) and ARM + Linux binaries. These are run less frequently (every Monday, Wednesday, and Friday). + - These are also uploaded to the [pulsar-edit/pulsar-rolling-releases](https://github.com/pulsar-edit/pulsar-rolling-releases/releases) + repository. + +To directly download a binary produced by GitHub Actions, follow the below steps: + +- Visit the Actions tab of the [`pulsar-edit/pulsar` repository at github.com](https://github.com/pulsar-edit/pulsar/actions/workflows/build.yml), + or visit a specific [Pull Request](https://github.com/pulsar-edit/pulsar/pulls) + that you wish to obtain binaries from. +- Log in to your GitHub account, or [create one](https://github.com/signup) + if you don't have one already. +- Visit the "Summary" page for any run of the "Build Pulsar Binaries" workflow, + and scroll down to the bottom of the page, where you will see the "Artifacts" + section. +- Download the desired binaries for your platform of choice. + - The labels are based on the CI runner, but the specific OS version should not + matter for your use. The "ubuntu" binaries are for any x64 Linux OSes. + The "macos-12" binaries are for any Intel-based Mac. Windows is x64-only + at this time. + To download a binary from Cirrus CI (Apple silicon and ARM Linux only) please follow the below steps: From 7d1ef96b1f8400ba3a4be444fea28a2236708df9 Mon Sep 17 00:00:00 2001 From: DeeDeeG Date: Fri, 19 Jul 2024 17:43:06 -0400 Subject: [PATCH 4/4] download: Apply another review suggestion from Daeraxa Co-authored-by: Daeraxa <58074586+Daeraxa@users.noreply.github.com> --- docs/download.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/download.md b/docs/download.md index 48b959888..dadd541f7 100644 --- a/docs/download.md +++ b/docs/download.md @@ -190,7 +190,7 @@ You can bypass this by clicking "More info" then "Run anyway". ## Manual download Binaries are built from a number of different branches and PRs but you should -stick to the **`master`** branch releases for the most stable ones unless you know +stick to the `master` branch releases for the most stable ones unless you know exactly what you are looking for. For the most convenient access to these recommended binaries