File 0003-Add-Rebar3-and-Erlang-OTP-compatibility-list.patch of Package rebar3
From 8e08292d14ce55098ce04dd35a2242411a355b5e Mon Sep 17 00:00:00 2001
From: Kian-Meng Ang <kianmeng@cpan.org>
Date: Thu, 26 Sep 2024 00:25:06 +0800
Subject: [PATCH] Add Rebar3 and Erlang/OTP compatibility list
Resolves https://github.com/erlang/rebar3/issues/2903 and bump Erlang
OTP version for macOS and GitHub actions.
Co-authored-by: Paulo F. Oliveira <paulo.ferraz.oliveira@gmail.com>
---
.github/workflows/main.yml | 10 ++++------
README.md | 22 +++++++++++++++++++++-
2 files changed, 25 insertions(+), 7 deletions(-)
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 71675513..94a3c8b2 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -19,7 +19,7 @@ jobs:
image: erlang:${{ matrix.otp_version }}
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v4
- name: Compile
run: ./bootstrap
- name: CT tests
@@ -36,7 +36,7 @@ jobs:
runs-on: macos-latest
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v4
- name: Brew Version Check
run: brew --version
- name: Brew Cleanup
@@ -52,9 +52,7 @@ jobs:
- name: Debug Brew
run: brew doctor || true
- name: Install Erlang
- #run: brew install erlang@${{ env.LATEST_OTP_RELEASE }}
- # fall back to OTP-26 since OTP 27.0 doesn't build on homebrew due to manpages issues
- run: brew install erlang@26
+ run: brew install erlang@${{ env.LATEST_OTP_RELEASE }}
- name: Compile
run: ./bootstrap
- name: CT tests
@@ -65,7 +63,7 @@ jobs:
runs-on: windows-latest
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v4
- name: Install Erlang
run: choco install erlang
- name: Compile
diff --git a/README.md b/README.md
index d4038b53..18ea8130 100644
--- a/README.md
+++ b/README.md
@@ -53,6 +53,27 @@ best experience you can get.
## Getting Started
+### Compatibility between Rebar3 and Erlang/OTP
+
+This list presents the known working version combos between Rebar3 and
+Erlang/OTP. Always use the latest version your project can tolerate for latest
+security fixes.
+
+| Rebar3 | Erlang/OTP Support Range | Notes
+|- |- | -
+| 3.24.0 | 25-27 |
+| 3.23.0 | 25-27 |
+| 3.22.1 | 25-27 |
+| 3.21.0 | 24-26 |
+| 3.20.0 | 23-25 |
+| 3.19.0 | 23-25 |
+| 3.18.0 | 22-24 |
+| 3.17.0 | 22-24 |
+| 3.16.1 | 22-24 | Don't use 3.16.0, see https://ferd.ca/you-ve-got-to-upgrade-rebar3.html
+| 3.15.2 | 19-23 | Don't use 3.15.0 or 3.15.1, see https://ferd.ca/you-ve-got-to-upgrade-rebar3.html
+| 3.14.1 | 19-23 |
+| 3.13.3 | 19-22 | Don't use 3.13.1 or 3.13.2, see https://ferd.ca/you-ve-got-to-upgrade-rebar3.html
+
A [getting started guide is maintained on the official documentation website](https://rebar3.org/docs/getting-started),
but installing rebar3 can be done by any of the ways described below
@@ -167,4 +188,3 @@ General rebar community resources and links can be found at
[rebar3.org/docs/about/about-us/#community](https://rebar3.org/docs/about/about-us/#community)
To contribute to rebar3, please refer to [CONTRIBUTING](CONTRIBUTING.md).
-
--
2.43.0
