Skip to content

Commit 10c1602

Browse files
authored
Merge pull request #278 from pulsar-edit/tweak-manual-download-wording
Tweak wording for the "Manual download" info on the download page
2 parents 52e55ed + 7d1ef96 commit 10c1602

File tree

1 file changed

+38
-15
lines changed

1 file changed

+38
-15
lines changed

docs/download.md

Lines changed: 38 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -190,32 +190,55 @@ You can bypass this by clicking "More info" then "Run anyway".
190190
## Manual download
191191

192192
Binaries are built from a number of different branches and PRs but you should
193-
stick to the **master** branch releases for the most stable ones unless you know
193+
stick to the `master` branch releases for the most stable ones unless you know
194194
exactly what you are looking for.
195195

196-
We currently build on both GitHub Actions and Cirrus CI:
197-
198-
- GitHub Actions is used for building the majority of our binaries and builds
199-
are run on every commit or PR.
200-
- Direct artifact download is available only for those with at least read
201-
permission on the repository. All artifacts are therefore automatically
202-
uploaded to the [pulsar-edit/pulsar-rolling-releases](https://github.com/pulsar-edit/pulsar-rolling-releases/releases)
203-
repository for access by anyone.
204-
- Cirrus CI is _only_ used for building Apple silicon (macOS M1/M2) and ARM
205-
Linux binaries. These are run less frequently (every Monday, Wednesday, and Friday).
206-
207-
To download a binary produced by GitHub Actions then follow the below steps:
196+
For the most convenient access to these recommended binaries
197+
from the `master` branch, please visit our Rolling Releases repository on GitHub:
208198

209199
- Navigate to the [pulsar-edit/pulsar-rolling-releases](https://github.com/pulsar-edit/pulsar-rolling-releases/releases)
210200
releases.
211201
- Select the most recent release (or for a specific release reference the timestamp
212202
part of the version e.g. 1.109.**2023091606**).
213-
- Most binaries will be available with every release but Apple silicon and
214-
ARM Linux binaries will not. You may need to look for earlier releases.
203+
- x86_64 binaries will be grouped together for most releases,
204+
but occasionally they will be split across multiple releases.
205+
Apple silicon and ARM Linux binaries are usually, but not always,
206+
grouped together in their own separate release. You may need to look through
207+
the earlier releases to find binaries for your platform.
215208
- Choose the binary you wish to download from the `Assets` section (you may need
216209
click the `Show all x assets` link to display them all). See below for
217210
descriptions of all available binaries.
218211

212+
We currently build on both GitHub Actions and Cirrus CI:
213+
214+
- GitHub Actions is used for building the majority of our binaries and builds
215+
are run on every commit or PR.
216+
- Direct artifact download is available only for those who are logged in
217+
with their GitHub accounts.
218+
- All artifacts from the `master` branch
219+
are therefore automatically uploaded to the [pulsar-edit/pulsar-rolling-releases](https://github.com/pulsar-edit/pulsar-rolling-releases/releases)
220+
repository for convenient access by anyone.
221+
- Cirrus CI is _only_ used for building Apple silicon (macOS M1/M2) and ARM
222+
Linux binaries. These are run less frequently (every Monday, Wednesday, and Friday).
223+
- These are also uploaded to the [pulsar-edit/pulsar-rolling-releases](https://github.com/pulsar-edit/pulsar-rolling-releases/releases)
224+
repository.
225+
226+
To directly download a binary produced by GitHub Actions, follow the below steps:
227+
228+
- Visit the Actions tab of the [`pulsar-edit/pulsar` repository at github.com](https://github.com/pulsar-edit/pulsar/actions/workflows/build.yml),
229+
or visit a specific [Pull Request](https://github.com/pulsar-edit/pulsar/pulls)
230+
that you wish to obtain binaries from.
231+
- Log in to your GitHub account, or [create one](https://github.com/signup)
232+
if you don't have one already.
233+
- Visit the "Summary" page for any run of the "Build Pulsar Binaries" workflow,
234+
and scroll down to the bottom of the page, where you will see the "Artifacts"
235+
section.
236+
- Download the desired binaries for your platform of choice.
237+
- The labels are based on the CI runner, but the specific OS version should not
238+
matter for your use. The "ubuntu" binaries are for any x64 Linux OSes.
239+
The "macos-12" binaries are for any Intel-based Mac. Windows is x64-only
240+
at this time.
241+
219242
To download a binary from Cirrus CI (Apple silicon and ARM Linux only) please
220243
follow the below steps:
221244

0 commit comments

Comments
 (0)