Skip to content

Commit 470d220

Browse files
authored
Bump Elixir and Erlang versions (#946)
* Reformat README * Update GitHub workflow Elixir and OTP versions * Update README versions
1 parent 15e12d8 commit 470d220

File tree

3 files changed

+16
-10
lines changed

3 files changed

+16
-10
lines changed

.github/workflows/cd.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ jobs:
2424
env:
2525
MIX_ENV: prod
2626
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
27-
ELIXIR_VERSION: "1.13.3"
28-
OTP_VERSION: "24.2.1"
27+
ELIXIR_VERSION: 1.13.4
28+
OTP_VERSION: 25.3.2
2929
steps:
3030
- uses: rlespinasse/github-slug-action@v3.x
3131
- uses: actions/checkout@v2

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ jobs:
2323
env:
2424
MIX_ENV: test
2525
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26-
ELIXIR_VERSION: "1.13.3"
27-
OTP_VERSION: "24.2.1"
26+
ELIXIR_VERSION: 1.13.4
27+
OTP_VERSION: 25.3.2
2828
services:
2929
postgres:
3030
image: postgres:14.2

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Cadet is the web application powering Source Academy.
1414

1515
### System requirements
1616

17-
1. Elixir 1.13.3
18-
2. Erlang/OTP 23.2.1
17+
1. Elixir 1.13.3+ (current version: 1.13.4)
18+
2. Erlang/OTP 23.2.1+ (current version: 25.3.2)
1919
3. PostgreSQL 13 or 14
2020

2121
It is probably okay to use a different version of PostgreSQL or Erlang/OTP, but using a different version of Elixir may result in differences in e.g. `mix format`.
@@ -29,14 +29,16 @@ It is probably okay to use a different version of PostgreSQL or Erlang/OTP, but
2929
$ vim config/dev.secrets.exs
3030
```
3131

32-
- To use NUSNET authentication, specify the NUS ADFS OAuth2 URL. (Ask for it.) Note that the frontend will supply the ADFS client ID and redirect URL (so you will need that too, but not here).
32+
- To use NUSNET authentication, specify the NUS ADFS OAuth2 URL. (Ask for it.) Note that the frontend will supply the ADFS client ID and redirect URL (so you will need that too, but not here).
3333

3434
2. Install Elixir dependencies
3535

3636
```bash
3737
$ mix deps.get
3838
```
39+
3940
If you encounter error message `Fail to fetch record for 'hexpm/mime' from registry(using cache insted)`The following instruction may be useful for you.
41+
4042
```bash
4143
$ mix local.hex --force
4244
```
@@ -46,12 +48,16 @@ It is probably okay to use a different version of PostgreSQL or Erlang/OTP, but
4648
```bash
4749
$ mix ecto.setup
4850
```
51+
4952
If you encounter error message about invalid password for the user "postgres".
5053
You should reset the "postgres" password:
54+
5155
```bash
5256
$ sudo -u postgres psql -c "ALTER USER postgres PASSWORD 'postgres';"
5357
```
58+
5459
and restart postgres service:
60+
5561
```bash
5662
$ sudo service postgresql restart
5763
```
@@ -62,7 +68,7 @@ It is probably okay to use a different version of PostgreSQL or Erlang/OTP, but
6268
$ mix phx.server
6369
```
6470

65-
5. You may now make API calls to the server locally via `localhost:4000`. The API documentation can also be accessed at http://localhost:4000/swagger.
71+
5. You may now make API calls to the server locally via `localhost:4000`. The API documentation can also be accessed at <http://localhost:4000/swagger>.
6672

6773
If you don't need to test MQTT connections for remote execution using [Sling](source-academy/sling), you can stop here. Otherwise, continue to [set up the local development environment with MQTT](#setting-up-a-local-development-environment-with-mqtt-support).
6874

@@ -110,7 +116,7 @@ In addition to performing the steps [above](#setting-up-your-local-development-e
110116

111117
- `get_endpoint_address` gives the address the EV3 should connect to (under normal operations). The address should be the local IP address of the computer hosting the MQTT server. Again, take note of the port number.
112118
<details><summary>Sidenote on connecting from the EV3</summary>
113-
119+
114120
We will not actually use this return value for anything, so the actual value. We just need to hardcode something to return (and stop the backend from trying to connect to AWS). Also, it is good practice to assume that the value is going to be used anyway:
115121
</details>
116122

@@ -138,7 +144,7 @@ $ mix help cadet.token
138144

139145
### Style Guide
140146

141-
We follow this style guide: https://github.com/lexmag/elixir-style-guide and https://github.com/christopheradams/elixir_style_guide
147+
We follow this style guide: <https://github.com/lexmag/elixir-style-guide> and <https://github.com/christopheradams/elixir_style_guide>
142148

143149
Where there is a conflict between the two, the first one (lexmag) shall be the one followed.
144150

0 commit comments

Comments
 (0)