Skip to content

Commit

Permalink
Update version to v1.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Neilpang committed Oct 6, 2024
1 parent bf17a4a commit c963419
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Use this action to run your CI in FreeBSD.

The github workflow only supports Ubuntu, Windows and MacOS. But what if you need to use FreeBSD?

This action is to support FreeBSD.


Sample workflow `test.yml`:

## 1. Example: `test.yml`:

```yml

Expand Down Expand Up @@ -72,6 +72,10 @@ So, you will have the same directory and same default env variables when you `ru

The default shell in FreeBSD(before 14.0) is `csh`, if you want to use `sh` to execute the `run` script, please set `usesh` to `true`.



## 2. Share code

The code is shared from the host to the VM via `rsync` by default, you can choose to use to `sshfs` share code instead.


Expand Down Expand Up @@ -129,6 +133,7 @@ When using `rsync`, you can define `copyback: false` to not copy files back fro
```
## 3. NAT from host runner to the VM
You can add NAT port between the host and the VM.
Expand All @@ -150,6 +155,8 @@ You can add NAT port between the host and the VM.
```
## 4. Set memory and cpu
The default memory of the VM is 6144MB, you can use `mem` option to set the memory size:
```
Expand Down Expand Up @@ -183,6 +190,9 @@ The VM is using all the cpu cores of the host by default, you can use `cpu` opti
...
```
## 5. Select release
It uses [the FreeBSD 14.1](conf/default.release.conf) by default, you can use `release` option to use another version of FreeBSD:
```
Expand All @@ -201,6 +211,7 @@ All the supported releases are here: FreeBSD 12.4, 13.2, 13.3, 13.4, 14.0, 14.1
## 6. Custom shell
Support custom shell:
Expand Down

0 comments on commit c963419

Please sign in to comment.