Skip to content

Commit 4ce27bf

Browse files
committedFeb 26, 2025
Add notes for MacOS users on how to use the migration script
Signed-off-by: Talwinder Singh <[email protected]>
1 parent 0704c59 commit 4ce27bf

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed
 

‎docs/user-guide/update-an-existing-project.md

+24
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,30 @@ curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-
2929
Make sure that the version (`{{ ref_name }}`) matches the
3030
target version you are migrating to.
3131

32+
!!! Tip "Tip for MacOS users"
33+
34+
The migration script may not work out of the box on macOS. You need to
35+
install `coreutils` to ensure compatibility:
36+
37+
```sh
38+
brew install coreutils gnu-sed
39+
```
40+
41+
After installation, update your `PATH` in your shell configuration
42+
(e.g. ~/.zshrc) so that the system uses the GNU versions. Depending on
43+
where the packages are installed this might look like this:
44+
45+
```sh
46+
export PATH="/opt/homebrew/opt/coreutils/libexec/gnubin:/opt/homebrew/opt/gnu-sed/libexec/gnubin:$PATH"
47+
export MANPATH="/opt/homebrew/opt/coreutils/libexec/gnuman:$MANPATH"
48+
```
49+
50+
Then, source your configuration file again to apply the changes:
51+
52+
```sh
53+
source ~/.zshrc # or ~/.bashrc, depending on your shell
54+
```
55+
3256
## Re-run the Cookiecutter command
3357

3458
If you are upgrading a very old project (jumping multiple versions at the time)

0 commit comments

Comments
 (0)