From c96341966a3954a757e6ea41692f7c7b32312a0c Mon Sep 17 00:00:00 2001 From: Neilpang Date: Sun, 6 Oct 2024 12:39:47 +0000 Subject: [PATCH] Update version to v1.1.3 --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8c91c6f..fdcb66b 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. @@ -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. @@ -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: ``` @@ -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: ``` @@ -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: