@htekdev/actions-debugger 1.0.50 → 1.0.51
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/errors/runner-environment/runner-environment-106.yml +110 -0
- package/errors/runner-environment/runner-environment-107.yml +105 -0
- package/errors/runner-environment/runner-environment-108.yml +109 -0
- package/errors/runner-environment/runner-environment-109.yml +121 -0
- package/package.json +1 -1
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
id: runner-environment-106
|
|
2
|
+
title: 'Windows Server 2019 (windows-2019) runner retired April 1, 2025 — jobs fail or queue indefinitely'
|
|
3
|
+
category: runner-environment
|
|
4
|
+
severity: error
|
|
5
|
+
tags:
|
|
6
|
+
- windows-2019
|
|
7
|
+
- runner-retirement
|
|
8
|
+
- windows-server-2019
|
|
9
|
+
- deprecated-runner
|
|
10
|
+
- github-hosted
|
|
11
|
+
- runs-on
|
|
12
|
+
- visual-studio-2019
|
|
13
|
+
patterns:
|
|
14
|
+
- regex: 'runs-on:\s*windows-2019'
|
|
15
|
+
flags: 'i'
|
|
16
|
+
- regex: 'No runner matching the specified labels was found.*windows-2019|Requested labels:\s*windows-2019'
|
|
17
|
+
flags: 'i'
|
|
18
|
+
error_messages:
|
|
19
|
+
- 'No runner matching the specified labels was found: windows-2019'
|
|
20
|
+
- '##[error]No runner matching the specified labels was found'
|
|
21
|
+
- 'Runner not found matching labels: [windows-2019]'
|
|
22
|
+
root_cause: |
|
|
23
|
+
GitHub retired the Windows Server 2019 (windows-2019) GitHub-hosted runner on
|
|
24
|
+
April 1, 2025. After this date, workflows specifying runs-on: windows-2019 can
|
|
25
|
+
no longer be scheduled on a GitHub-hosted runner matching that label.
|
|
26
|
+
|
|
27
|
+
GitHub announced the deprecation in September 2024 (90+ days notice) with
|
|
28
|
+
brownout periods beginning before the hard cutoff. windows-latest had already
|
|
29
|
+
transitioned to point to windows-2022 (Windows Server 2022 with Visual Studio
|
|
30
|
+
2022) on October 28, 2024, giving teams an early signal.
|
|
31
|
+
|
|
32
|
+
Workflows most affected:
|
|
33
|
+
- Files explicitly specifying runs-on: windows-2019 (not windows-latest)
|
|
34
|
+
- Builds relying on Visual Studio 2019 toolset version v142 MSBuild tools
|
|
35
|
+
- .csproj files with hardcoded <PlatformToolset>v142</PlatformToolset>
|
|
36
|
+
- Workflows using .NET Framework or SDK behaviors specific to the VS2019 era
|
|
37
|
+
- Actions pinned to a major version that internally specified windows-2019
|
|
38
|
+
- Forks and template repositories written before windows-2022 was the default
|
|
39
|
+
|
|
40
|
+
A secondary migration concern: workflows that used windows-latest and relied on
|
|
41
|
+
VS2019 behavior were silently broken when windows-latest moved to windows-2022
|
|
42
|
+
in October 2024. Pinning to windows-2019 was a common workaround — the
|
|
43
|
+
retirement forced resolution of both the workaround and the underlying toolset
|
|
44
|
+
incompatibility simultaneously.
|
|
45
|
+
fix: |
|
|
46
|
+
Replace runs-on: windows-2019 with a supported Windows runner label:
|
|
47
|
+
|
|
48
|
+
- windows-2022 — Windows Server 2022, Visual Studio 2022 (toolset v143)
|
|
49
|
+
- windows-2025 — Windows Server 2025, Visual Studio 2022 (available 2025)
|
|
50
|
+
- windows-latest — currently maps to windows-2022
|
|
51
|
+
|
|
52
|
+
If your workflow uses MSBuild and specifies PlatformToolset=v142 (VS2019
|
|
53
|
+
toolset), you have two options:
|
|
54
|
+
1. Update project files to remove the explicit PlatformToolset element and
|
|
55
|
+
let MSBuild select the installed toolset automatically (preferred).
|
|
56
|
+
2. Migrate the .csproj to PlatformToolset v143 (VS2022 toolset).
|
|
57
|
+
|
|
58
|
+
Check these locations for VS2019-specific behavior:
|
|
59
|
+
- .csproj files with <PlatformToolset>v142</PlatformToolset>
|
|
60
|
+
- Hardcoded paths like C:\Program Files (x86)\Microsoft Visual Studio\2019\...
|
|
61
|
+
- vcpkg toolchain files referencing VS2019 installs
|
|
62
|
+
- Workflow env: blocks with hardcoded VSINSTALLDIR paths
|
|
63
|
+
fix_code:
|
|
64
|
+
- language: yaml
|
|
65
|
+
label: 'Replace retired windows-2019 with windows-2022'
|
|
66
|
+
code: |
|
|
67
|
+
jobs:
|
|
68
|
+
build:
|
|
69
|
+
# Before: runs-on: windows-2019 <- retired April 1, 2025
|
|
70
|
+
runs-on: windows-2022
|
|
71
|
+
steps:
|
|
72
|
+
- uses: actions/checkout@v4
|
|
73
|
+
|
|
74
|
+
- name: Setup MSBuild
|
|
75
|
+
uses: microsoft/setup-msbuild@v2
|
|
76
|
+
|
|
77
|
+
- name: Build solution
|
|
78
|
+
run: msbuild solution.sln /p:Configuration=Release /p:Platform="Any CPU"
|
|
79
|
+
# If build fails on toolset version, update PlatformToolset in .csproj
|
|
80
|
+
# from v142 (VS2019) to v143 (VS2022) or remove it to auto-select
|
|
81
|
+
|
|
82
|
+
- language: yaml
|
|
83
|
+
label: 'Matrix across Windows versions to verify migration before cutover'
|
|
84
|
+
code: |
|
|
85
|
+
jobs:
|
|
86
|
+
build:
|
|
87
|
+
strategy:
|
|
88
|
+
matrix:
|
|
89
|
+
# windows-2019 removed — retired April 1, 2025
|
|
90
|
+
os: [windows-2022]
|
|
91
|
+
fail-fast: false
|
|
92
|
+
runs-on: ${{ matrix.os }}
|
|
93
|
+
steps:
|
|
94
|
+
- uses: actions/checkout@v4
|
|
95
|
+
- name: Setup MSBuild
|
|
96
|
+
uses: microsoft/setup-msbuild@v2
|
|
97
|
+
- name: Build
|
|
98
|
+
run: msbuild solution.sln /p:Configuration=Release
|
|
99
|
+
prevention:
|
|
100
|
+
- 'Use windows-latest or windows-2022 — never pin to a specific older Windows runner label for long-lived workflows'
|
|
101
|
+
- 'Avoid hardcoding Visual Studio toolset versions (v142, v143) in .csproj files — let MSBuild auto-select the installed toolset'
|
|
102
|
+
- 'Subscribe to GitHub Changelog at github.blog/changelog to receive runner retirement announcements before hard cutoff dates'
|
|
103
|
+
- 'Test on windows-2022 in a feature branch before any deprecation deadline to catch VS toolset migration issues early'
|
|
104
|
+
docs:
|
|
105
|
+
- url: 'https://github.blog/changelog/2024-09-12-windows-2019-actions-runner-image-brownout-and-deprecation/'
|
|
106
|
+
label: 'GitHub Changelog: Windows 2019 runner image brownout and deprecation'
|
|
107
|
+
- url: 'https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources'
|
|
108
|
+
label: 'GitHub Docs: Supported GitHub-hosted runners and hardware resources'
|
|
109
|
+
- url: 'https://github.com/actions/runner-images'
|
|
110
|
+
label: 'actions/runner-images: GitHub-hosted runner image specifications'
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
id: runner-environment-107
|
|
2
|
+
title: 'Ubuntu 24.04 runner: unversioned python command absent — /usr/bin/env: python: No such file or directory'
|
|
3
|
+
category: runner-environment
|
|
4
|
+
severity: error
|
|
5
|
+
tags:
|
|
6
|
+
- ubuntu-24
|
|
7
|
+
- python
|
|
8
|
+
- python3
|
|
9
|
+
- unversioned-alias
|
|
10
|
+
- command-not-found
|
|
11
|
+
- ubuntu-noble
|
|
12
|
+
- ubuntu-latest
|
|
13
|
+
patterns:
|
|
14
|
+
- regex: '/usr/bin/env:\s*[''"]?python[''"]?:\s*No such file|python:\s*command not found'
|
|
15
|
+
flags: 'i'
|
|
16
|
+
- regex: 'runs-on:\s*ubuntu-2[4-9]|runs-on:\s*ubuntu-latest'
|
|
17
|
+
flags: 'i'
|
|
18
|
+
error_messages:
|
|
19
|
+
- '/usr/bin/env: python: No such file or directory'
|
|
20
|
+
- 'python: command not found'
|
|
21
|
+
- '##[error]Process completed with exit code 127.'
|
|
22
|
+
root_cause: |
|
|
23
|
+
Ubuntu 24.04 (Noble Numbat) does not install the unversioned python command by
|
|
24
|
+
default. Only python3 (Python 3.12+) is present in the PATH. This follows
|
|
25
|
+
PEP 394 guidance and a deliberate Ubuntu packaging decision: the
|
|
26
|
+
python3-is-python package (which creates a /usr/bin/python -> python3 symlink)
|
|
27
|
+
is not pre-installed on GitHub-hosted Ubuntu 24.04 runners.
|
|
28
|
+
|
|
29
|
+
As of November 2024, ubuntu-latest on GitHub-hosted runners maps to ubuntu-24.04.
|
|
30
|
+
Workflows that ran on ubuntu-latest (previously ubuntu-22.04) began failing
|
|
31
|
+
because Ubuntu 22.04 runners had side-effected python aliases through
|
|
32
|
+
actions/setup-python or the python-is-python3 shim, while the Ubuntu 24.04
|
|
33
|
+
baseline has no unversioned python at all.
|
|
34
|
+
|
|
35
|
+
Affected patterns:
|
|
36
|
+
- run: python script.py
|
|
37
|
+
- run: python -m pytest
|
|
38
|
+
- Shell scripts with #!/usr/bin/env python shebang lines
|
|
39
|
+
- Makefile targets invoking python
|
|
40
|
+
- Third-party composite actions that call python internally without setup-python
|
|
41
|
+
- pip invocations — pip is also absent (only pip3 available)
|
|
42
|
+
fix: |
|
|
43
|
+
Option 1 (recommended): Use actions/setup-python before any step that needs
|
|
44
|
+
Python. This installs a versioned Python and creates both python and python3
|
|
45
|
+
symlinks in PATH, resolving the problem portably across all runner OS versions.
|
|
46
|
+
|
|
47
|
+
Option 2: Replace all python invocations with python3 in workflow files.
|
|
48
|
+
Also replace pip with pip3 or python3 -m pip. Works if you control all scripts
|
|
49
|
+
but misses shebangs in vendor code or third-party tools.
|
|
50
|
+
|
|
51
|
+
Option 3: Install the alias manually in a setup step:
|
|
52
|
+
sudo apt-get install -y python-is-python3
|
|
53
|
+
This creates the /usr/bin/python -> python3 symlink immediately. The package is
|
|
54
|
+
already in the apt cache — install is fast with no download required.
|
|
55
|
+
fix_code:
|
|
56
|
+
- language: yaml
|
|
57
|
+
label: 'Use actions/setup-python (recommended — portable across all runner versions)'
|
|
58
|
+
code: |
|
|
59
|
+
jobs:
|
|
60
|
+
test:
|
|
61
|
+
runs-on: ubuntu-latest
|
|
62
|
+
steps:
|
|
63
|
+
- uses: actions/checkout@v4
|
|
64
|
+
|
|
65
|
+
- name: Set up Python
|
|
66
|
+
uses: actions/setup-python@v5
|
|
67
|
+
with:
|
|
68
|
+
python-version: '3.12'
|
|
69
|
+
# Creates both python and python3 aliases in PATH
|
|
70
|
+
|
|
71
|
+
- name: Install dependencies
|
|
72
|
+
run: python -m pip install -r requirements.txt
|
|
73
|
+
|
|
74
|
+
- name: Run tests
|
|
75
|
+
run: python -m pytest tests/
|
|
76
|
+
|
|
77
|
+
- language: yaml
|
|
78
|
+
label: 'Install python-is-python3 alias for scripts with hardcoded python shebangs'
|
|
79
|
+
code: |
|
|
80
|
+
jobs:
|
|
81
|
+
build:
|
|
82
|
+
runs-on: ubuntu-latest
|
|
83
|
+
steps:
|
|
84
|
+
- uses: actions/checkout@v4
|
|
85
|
+
|
|
86
|
+
- name: Install python alias
|
|
87
|
+
run: sudo apt-get install -y python-is-python3
|
|
88
|
+
# Creates /usr/bin/python -> python3 symlink
|
|
89
|
+
# Fast: package already in apt cache on ubuntu-24.04
|
|
90
|
+
|
|
91
|
+
- name: Run script with python shebang
|
|
92
|
+
run: ./scripts/legacy-build.sh
|
|
93
|
+
# Script uses #!/usr/bin/env python internally
|
|
94
|
+
prevention:
|
|
95
|
+
- 'Always use actions/setup-python in workflows that invoke python — portable and creates the python alias on all runner OS versions'
|
|
96
|
+
- 'Avoid relying on system Python; python version and alias availability varies between Ubuntu 22.04 and 24.04'
|
|
97
|
+
- 'When ubuntu-latest bumps to a new Ubuntu version, search run: blocks and scripts for bare python and pip invocations'
|
|
98
|
+
- 'Pin ubuntu-24.04 explicitly during transition testing rather than ubuntu-latest to catch breakage before it hits production'
|
|
99
|
+
docs:
|
|
100
|
+
- url: 'https://github.com/actions/runner-images/issues/9654'
|
|
101
|
+
label: 'runner-images#9654: python command not found on Ubuntu 24.04'
|
|
102
|
+
- url: 'https://github.com/actions/runner-images'
|
|
103
|
+
label: 'actions/runner-images: GitHub-hosted runner image specifications'
|
|
104
|
+
- url: 'https://github.com/actions/setup-python'
|
|
105
|
+
label: 'actions/setup-python: Set up a Python environment for use in Actions'
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
id: runner-environment-108
|
|
2
|
+
title: 'Ubuntu 22.04 runner: libssl.so.1.1 missing — binaries compiled on Ubuntu 20.04 fail with cannot open shared object file'
|
|
3
|
+
category: runner-environment
|
|
4
|
+
severity: error
|
|
5
|
+
tags:
|
|
6
|
+
- ubuntu-22
|
|
7
|
+
- libssl
|
|
8
|
+
- openssl3
|
|
9
|
+
- shared-library
|
|
10
|
+
- binary-compatibility
|
|
11
|
+
- ubuntu-jammy
|
|
12
|
+
- dynamic-linking
|
|
13
|
+
patterns:
|
|
14
|
+
- regex: 'libssl\.so\.1\.1.*cannot open shared object file|error while loading shared libraries: libssl\.so\.1\.1'
|
|
15
|
+
flags: 'i'
|
|
16
|
+
- regex: 'libcrypto\.so\.1\.1.*cannot open shared object file'
|
|
17
|
+
flags: 'i'
|
|
18
|
+
error_messages:
|
|
19
|
+
- 'error while loading shared libraries: libssl.so.1.1: cannot open shared object file: No such file or directory'
|
|
20
|
+
- '/usr/lib/x86_64-linux-gnu/libssl.so.1.1: No such file or directory'
|
|
21
|
+
- 'error while loading shared libraries: libcrypto.so.1.1: cannot open shared object file: No such file or directory'
|
|
22
|
+
root_cause: |
|
|
23
|
+
Ubuntu 22.04 (Jammy) ships OpenSSL 3.0, replacing OpenSSL 1.1. The shared
|
|
24
|
+
library libssl.so.1.1 is absent — the libssl1.1 package that provided it is
|
|
25
|
+
not available in the Ubuntu 22.04 (jammy) package repository at all; it was
|
|
26
|
+
a focal (Ubuntu 20.04) package only.
|
|
27
|
+
|
|
28
|
+
When ubuntu-latest transitioned from Ubuntu 20.04 to Ubuntu 22.04 in 2022,
|
|
29
|
+
CI pipelines that downloaded or shipped pre-compiled binaries started failing
|
|
30
|
+
because those binaries were dynamically linked against libssl1.1. Common
|
|
31
|
+
scenarios that trigger this error:
|
|
32
|
+
|
|
33
|
+
- Self-hosted runners migrated from Ubuntu 20.04 to 22.04 while tool cache
|
|
34
|
+
contains pre-compiled focal binaries
|
|
35
|
+
- Docker images with pre-compiled binaries using libssl1.1 run in container
|
|
36
|
+
jobs on ubuntu-22.04 hosts
|
|
37
|
+
- Ruby gems with native extensions (mysql2, pg, ruby-openssl) compiled on
|
|
38
|
+
Ubuntu 20.04 and installed from a cached bundler path
|
|
39
|
+
- Node.js native add-ons (node-gyp built) that link against libssl1.1
|
|
40
|
+
- Custom CLI tools shipped as pre-built .deb or tar.gz for Ubuntu 20.04
|
|
41
|
+
- Python C extension packages (pycurl, cryptography old versions) with
|
|
42
|
+
libssl1.1 runtime dependency
|
|
43
|
+
|
|
44
|
+
libcrypto.so.1.1 is also absent — tools linked against both libraries fail
|
|
45
|
+
with the same error on whichever library is loaded first.
|
|
46
|
+
fix: |
|
|
47
|
+
Option 1 (best long-term): Recompile the affected binary for Ubuntu 22.04 or
|
|
48
|
+
later against OpenSSL 3.0 (libssl3). Ubuntu 20.04 reached end-of-standard-support
|
|
49
|
+
in April 2025 — new binaries should target OpenSSL 3.0.
|
|
50
|
+
|
|
51
|
+
Option 2: Install a libssl1.1 compatibility .deb backported from Ubuntu 20.04
|
|
52
|
+
focal. Add an install step using the focal security archive. This is a
|
|
53
|
+
temporary workaround — the package receives no security patches on 22.04.
|
|
54
|
+
|
|
55
|
+
Option 3: Use a container job with ubuntu:20.04 base image for steps that
|
|
56
|
+
require libssl1.1, isolating the dependency from the host runner OS.
|
|
57
|
+
|
|
58
|
+
Option 4: Pin runs-on: ubuntu-20.04 temporarily while planning recompile.
|
|
59
|
+
ubuntu-20.04 runners will eventually be retired — plan a migration timeline.
|
|
60
|
+
fix_code:
|
|
61
|
+
- language: yaml
|
|
62
|
+
label: 'Install libssl1.1 compatibility shim from Ubuntu 20.04 focal archive (temporary workaround)'
|
|
63
|
+
code: |
|
|
64
|
+
jobs:
|
|
65
|
+
build:
|
|
66
|
+
runs-on: ubuntu-22.04
|
|
67
|
+
steps:
|
|
68
|
+
- uses: actions/checkout@v4
|
|
69
|
+
|
|
70
|
+
- name: Install libssl1.1 compatibility shim
|
|
71
|
+
run: |
|
|
72
|
+
wget -q http://security.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2_amd64.deb
|
|
73
|
+
sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2_amd64.deb
|
|
74
|
+
# WARNING: Temporary workaround only. Recompile binary against OpenSSL 3.0 for the permanent fix.
|
|
75
|
+
|
|
76
|
+
- name: Run legacy binary
|
|
77
|
+
run: ./vendor/legacy-tool
|
|
78
|
+
|
|
79
|
+
- language: yaml
|
|
80
|
+
label: 'Use container job with ubuntu:20.04 base image to isolate libssl1.1 dependency'
|
|
81
|
+
code: |
|
|
82
|
+
jobs:
|
|
83
|
+
build:
|
|
84
|
+
runs-on: ubuntu-latest
|
|
85
|
+
container:
|
|
86
|
+
image: ubuntu:20.04
|
|
87
|
+
steps:
|
|
88
|
+
- uses: actions/checkout@v4
|
|
89
|
+
|
|
90
|
+
- name: Install prerequisites
|
|
91
|
+
run: |
|
|
92
|
+
apt-get update
|
|
93
|
+
apt-get install -y libssl1.1 curl
|
|
94
|
+
|
|
95
|
+
- name: Run legacy binary
|
|
96
|
+
run: ./vendor/legacy-tool
|
|
97
|
+
# Binary now runs with libssl1.1 available in container
|
|
98
|
+
prevention:
|
|
99
|
+
- 'Compile release binaries against the same OpenSSL version as the target runner OS (3.0 for Ubuntu 22.04+)'
|
|
100
|
+
- 'When upgrading ubuntu-latest, audit all pre-compiled binaries with ldd to check for libssl.so.1.1 dynamic dependencies before rolling out'
|
|
101
|
+
- 'Use statically-linked binaries or distroless container images for tools that must run across multiple Ubuntu versions'
|
|
102
|
+
- 'In matrix workflows, include ubuntu-22.04 alongside ubuntu-20.04 to catch OpenSSL ABI incompatibilities before retirement deadlines'
|
|
103
|
+
docs:
|
|
104
|
+
- url: 'https://github.com/actions/runner-images/issues/6399'
|
|
105
|
+
label: 'runner-images#6399: libssl.so.1.1 missing on Ubuntu 22.04'
|
|
106
|
+
- url: 'https://wiki.openssl.org/index.php/OpenSSL_3.0'
|
|
107
|
+
label: 'OpenSSL 3.0 migration guide — ABI compatibility with OpenSSL 1.1'
|
|
108
|
+
- url: 'https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners'
|
|
109
|
+
label: 'GitHub Docs: About GitHub-hosted runners'
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
id: runner-environment-109
|
|
2
|
+
title: 'macOS 14+ (Apple Silicon) runner: Homebrew prefix changed from /usr/local to /opt/homebrew — hardcoded paths fail'
|
|
3
|
+
category: runner-environment
|
|
4
|
+
severity: error
|
|
5
|
+
tags:
|
|
6
|
+
- macos-14
|
|
7
|
+
- apple-silicon
|
|
8
|
+
- homebrew
|
|
9
|
+
- arm64
|
|
10
|
+
- path
|
|
11
|
+
- macos-sonoma
|
|
12
|
+
- opt-homebrew
|
|
13
|
+
- cross-architecture
|
|
14
|
+
patterns:
|
|
15
|
+
- regex: '/usr/local/(bin/brew|Cellar|opt)\b'
|
|
16
|
+
flags: 'i'
|
|
17
|
+
- regex: 'No such file or directory.*(/usr/local/bin/brew|/usr/local/opt|/usr/local/Cellar)'
|
|
18
|
+
flags: 'i'
|
|
19
|
+
error_messages:
|
|
20
|
+
- '/usr/local/bin/brew: No such file or directory'
|
|
21
|
+
- 'Error: No such file or directory @ rb_sysopen - /usr/local/Cellar'
|
|
22
|
+
- '/usr/local/opt/openssl: No such file or directory'
|
|
23
|
+
- 'pkg-config: /usr/local/opt/openssl/lib/pkgconfig: No such file or directory'
|
|
24
|
+
root_cause: |
|
|
25
|
+
Homebrew on Apple Silicon (ARM64) installs to /opt/homebrew, while Homebrew on
|
|
26
|
+
Intel x86-64 installs to /usr/local. This architectural split was introduced when
|
|
27
|
+
Homebrew added native Apple Silicon support in early 2021.
|
|
28
|
+
|
|
29
|
+
GitHub-hosted macOS runners on Apple Silicon hardware (macos-14, macos-15, and
|
|
30
|
+
macos-latest since October 2024) use /opt/homebrew as the Homebrew prefix.
|
|
31
|
+
Workflows migrating from macOS 12 or macOS 13 (Intel x86-64) to macOS 14+
|
|
32
|
+
(Apple Silicon) break when they reference hardcoded /usr/local paths:
|
|
33
|
+
|
|
34
|
+
- /usr/local/bin/brew — the brew binary itself
|
|
35
|
+
- /usr/local/Cellar/package-name — installed package files
|
|
36
|
+
- /usr/local/opt/package-name — formula options/keg link (very common for
|
|
37
|
+
openssl, readline, libpq, libyaml, icu4c, pkg-config)
|
|
38
|
+
- PKG_CONFIG_PATH=/usr/local/opt/openssl/lib/pkgconfig in env: blocks
|
|
39
|
+
- OPENSSL_ROOT_DIR=/usr/local/opt/openssl in build steps
|
|
40
|
+
- LDFLAGS=-L/usr/local/opt/readline/lib for native extension builds
|
|
41
|
+
- CPPFLAGS=-I/usr/local/opt/openssl/include for C/C++ compilation
|
|
42
|
+
- Shell scripts that source /usr/local/etc/profile.d/
|
|
43
|
+
|
|
44
|
+
Commonly broken language ecosystems:
|
|
45
|
+
- Ruby gems with native extensions (nokogiri --with-opt-dir=/usr/local/opt/openssl)
|
|
46
|
+
- Python packages (pycurl, psycopg2, cryptography) with hardcoded CPPFLAGS
|
|
47
|
+
- Node.js native add-ons reading PKG_CONFIG_PATH pointing to /usr/local/opt
|
|
48
|
+
- Go builds with CGO_CFLAGS referencing /usr/local/include
|
|
49
|
+
fix: |
|
|
50
|
+
Replace all hardcoded /usr/local/opt and /usr/local/Cellar paths with the
|
|
51
|
+
dynamic output of brew --prefix [formula-name].
|
|
52
|
+
|
|
53
|
+
The portable pattern:
|
|
54
|
+
OPENSSL_ROOT_DIR=$(brew --prefix openssl)
|
|
55
|
+
PKG_CONFIG_PATH="$(brew --prefix openssl)/lib/pkgconfig"
|
|
56
|
+
|
|
57
|
+
brew --prefix returns /usr/local/opt/package on Intel and /opt/homebrew/opt/package
|
|
58
|
+
on Apple Silicon — making it correct on both architectures automatically.
|
|
59
|
+
|
|
60
|
+
For the Homebrew root itself, use the $HOMEBREW_PREFIX environment variable
|
|
61
|
+
which is pre-set by the runner image to the correct prefix (/usr/local or
|
|
62
|
+
/opt/homebrew) depending on the runner architecture.
|
|
63
|
+
|
|
64
|
+
Actionlint does not flag hardcoded /usr/local paths — a manual audit of
|
|
65
|
+
env: blocks and run: scripts is required when migrating runner architectures.
|
|
66
|
+
fix_code:
|
|
67
|
+
- language: yaml
|
|
68
|
+
label: 'Use brew --prefix for portable formula paths across Intel and Apple Silicon'
|
|
69
|
+
code: |
|
|
70
|
+
jobs:
|
|
71
|
+
build:
|
|
72
|
+
runs-on: macos-latest # macos-14+ on Apple Silicon (/opt/homebrew)
|
|
73
|
+
steps:
|
|
74
|
+
- uses: actions/checkout@v4
|
|
75
|
+
|
|
76
|
+
- name: Install dependencies
|
|
77
|
+
run: brew install openssl readline libpq
|
|
78
|
+
|
|
79
|
+
- name: Set library paths (portable — works on Intel and Apple Silicon)
|
|
80
|
+
run: |
|
|
81
|
+
echo "OPENSSL_ROOT_DIR=$(brew --prefix openssl)" >> $GITHUB_ENV
|
|
82
|
+
echo "PKG_CONFIG_PATH=$(brew --prefix openssl)/lib/pkgconfig:$(brew --prefix readline)/lib/pkgconfig" >> $GITHUB_ENV
|
|
83
|
+
echo "LDFLAGS=-L$(brew --prefix openssl)/lib -L$(brew --prefix readline)/lib" >> $GITHUB_ENV
|
|
84
|
+
echo "CPPFLAGS=-I$(brew --prefix openssl)/include -I$(brew --prefix readline)/include" >> $GITHUB_ENV
|
|
85
|
+
# DO NOT hardcode /usr/local/opt/... — breaks on Apple Silicon (/opt/homebrew)
|
|
86
|
+
|
|
87
|
+
- name: Install native gems
|
|
88
|
+
run: bundle install
|
|
89
|
+
|
|
90
|
+
- language: yaml
|
|
91
|
+
label: 'Use $HOMEBREW_PREFIX env variable for Homebrew root references'
|
|
92
|
+
code: |
|
|
93
|
+
jobs:
|
|
94
|
+
build:
|
|
95
|
+
runs-on: macos-latest
|
|
96
|
+
steps:
|
|
97
|
+
- uses: actions/checkout@v4
|
|
98
|
+
|
|
99
|
+
- name: Install tool
|
|
100
|
+
run: brew install libffi
|
|
101
|
+
|
|
102
|
+
- name: Build with native dependency
|
|
103
|
+
run: |
|
|
104
|
+
# $HOMEBREW_PREFIX is pre-set by the runner image
|
|
105
|
+
# Intel macOS 12/13: /usr/local
|
|
106
|
+
# Apple Silicon 14/15: /opt/homebrew
|
|
107
|
+
export LIBRARY_PATH="$HOMEBREW_PREFIX/lib:$LIBRARY_PATH"
|
|
108
|
+
export C_INCLUDE_PATH="$HOMEBREW_PREFIX/include:$C_INCLUDE_PATH"
|
|
109
|
+
make install
|
|
110
|
+
prevention:
|
|
111
|
+
- 'Never hardcode /usr/local/opt, /usr/local/Cellar, or /usr/local/bin/brew — always use brew --prefix <formula> at runtime'
|
|
112
|
+
- 'Use $HOMEBREW_PREFIX (set by runner images) for generic Homebrew root path references'
|
|
113
|
+
- 'When migrating from macos-12/13 (Intel) to macos-14+ (Apple Silicon), grep workflow files and scripts for /usr/local/ strings'
|
|
114
|
+
- 'Test with runs-on: macos-14 in a feature branch before switching macos-latest to catch architecture-specific path failures'
|
|
115
|
+
docs:
|
|
116
|
+
- url: 'https://docs.brew.sh/Installation'
|
|
117
|
+
label: 'Homebrew Installation docs: default prefix differences between Intel and Apple Silicon'
|
|
118
|
+
- url: 'https://github.com/actions/runner-images/blob/main/images/macos/macos-14-arm64-Readme.md'
|
|
119
|
+
label: 'actions/runner-images: macOS 14 ARM64 image README'
|
|
120
|
+
- url: 'https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners'
|
|
121
|
+
label: 'GitHub Docs: About GitHub-hosted runners — macOS runner architecture details'
|
package/package.json
CHANGED