From f23dd1fd6bd0b68d74e99a57b3889c9b8e2fd585 Mon Sep 17 00:00:00 2001 From: ClementTsang <34804052+ClementTsang@users.noreply.github.com> Date: Sat, 18 Feb 2023 23:23:46 -0500 Subject: [PATCH] other: promote macOS aarch64 to official support Since I have a macOS M1 laptop to test on now, I think it's a good time to bump it to be officially supported, especially since it's going to be the main macOS platform for the foreseeable feature. --- .github/workflows/build_releases.yml | 2 +- .github/workflows/ci.yml | 2 ++ .github/workflows/coverage.yml | 1 + CHANGELOG.md | 2 ++ README.md | 9 ++++----- docs/content/support/official.md | 2 +- docs/content/support/unofficial.md | 8 ++++---- 7 files changed, 15 insertions(+), 11 deletions(-) diff --git a/.github/workflows/build_releases.yml b/.github/workflows/build_releases.yml index cecee0f0b..1851f2390 100644 --- a/.github/workflows/build_releases.yml +++ b/.github/workflows/build_releases.yml @@ -77,7 +77,7 @@ jobs: cross: true, } - # macOS (x64) + # macOS (x64), M1 is built via CirrusCI. - { os: "macos-12", target: "x86_64-apple-darwin", cross: false } # Windows (x64, x86) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 84a87dbfb..f55b56e44 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -52,6 +52,8 @@ jobs: do_not_skip: '["workflow_dispatch", "push"]' # Runs rustfmt + tests + clippy on the main supported platforms. + # + # Note that m1 macOS is tested via CirrusCI. supported: needs: pre-job runs-on: ${{ matrix.info.os }} diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml index 4f30fca8a..514afd6f5 100644 --- a/.github/workflows/coverage.yml +++ b/.github/workflows/coverage.yml @@ -17,6 +17,7 @@ concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: ${{ github.event_name == 'pull_request' || github.repository != 'ClementTsang/bottom' }} +# TODO: Maybe add this for more than just Linux. jobs: pre-job: runs-on: ubuntu-latest diff --git a/CHANGELOG.md b/CHANGELOG.md index 16eb4ad80..1a8bf802f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Changes +- [#1025](https://github.com/ClementTsang/bottom/pull/1025): Officially support M1 macOS. + ## Other ## [0.8.0] - 2023-01-22 diff --git a/README.md b/README.md index a565062bf..08fdb5293 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ You can find more details in [the documentation](https://clementtsang.github.io/ bottom _officially_ supports the following operating systems and corresponding architectures: -- macOS (`x86_64`) +- macOS (`x86_64`, `aarch64`) - Linux (`x86_64`, `i686`, `aarch64`) - Windows (`x86_64`, `i686`) @@ -117,13 +117,12 @@ bottom may work on a number of platforms that aren't officially supported. Note - Might not be properly tested by maintainers prior to a stable release. - May only receive limited support, such as missing features or bugs that may not be fixed. -Note that some unsupported platforms may eventually be officially supported (e.g., FreeBSD, M1 macOS devices). +Note that some unsupported platforms may eventually be officially supported (e.g., FreeBSD). A non-comprehensive list of some currently unofficially supported platforms that may compile/work include: -- FreeBSD on `x86_64` -- Linux on `armv6`, `armv7`, `powerpc64le`, `riscv64gc` -- macOS on `aarch64` +- FreeBSD (`x86_64`) +- Linux (`armv6`, `armv7`, `powerpc64le`, `riscv64gc`) For more details on unsupported platforms and known problems, check out [the documentation](https://clementtsang.github.io/bottom/nightly/support/unofficial/). diff --git a/docs/content/support/official.md b/docs/content/support/official.md index 8c2ead8b0..fa9356eb6 100644 --- a/docs/content/support/official.md +++ b/docs/content/support/official.md @@ -2,7 +2,7 @@ bottom _officially_ supports the following operating systems and corresponding architectures: -- macOS (`x86_64`) +- macOS (`x86_64`, `aarch64`) - Linux (`x86_64`, `i686`, `aarch64`) - Windows (`x86_64`, `i686`) diff --git a/docs/content/support/unofficial.md b/docs/content/support/unofficial.md index 6a13be6a8..84a3d4c6a 100644 --- a/docs/content/support/unofficial.md +++ b/docs/content/support/unofficial.md @@ -1,15 +1,15 @@ # Unofficial support -Systems and architectures that aren't officially supported may still work, but there are no guarantees on how much will work. For example, it might only compile, or it might run with bugs/broken features. -Furthermore, while it will depend on the problem at the end of the day, _issues on unsupported platforms are likely to go unfixed_. +Systems and architectures that aren't officially supported may still work, but there are no guarantees on how much will +work. For example, it might only compile, or it might run with bugs/broken features. Furthermore, while it will depend +on the problem at the end of the day, _issues on unsupported platforms are likely to go unfixed_. Unofficially supported platforms known to compile/work: +- FreeBSD - Linux on ARMv7 and ARMv6 (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml)) -- macOS on AArch64 (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml)) - Linux on PowerPC 64 LE (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml)) - Linux on an RISC-V (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml), tested to run on an [Allwinner D1 Nezha](https://github.com/ClementTsang/bottom/issues/564)) -- FreeBSD ## Known problems