tools
/
action-setup-nginx
mirror of https://github.com/nyurik/action-setup-nginx.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

init

This commit is contained in:
Yuri Astrakhan 2024-05-21 20:23:21 -04:00
commit e329853d42
6 changed files with 669 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
.github/workflows/ci.yml vendored Normal file
View File

@ -0,0 +1,104 @@
name: CI
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
schedule:
- cron: "0 8 * * SUN"
workflow_dispatch:
defaults:
run:
shell: bash
jobs:
default:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os:
- ubuntu-latest
- ubuntu-24.04
- ubuntu-22.04
- ubuntu-20.04
- macos-latest
- macos-11
- macos-12
- macos-13
- macos-14 # M1 CPU
- windows-latest
- windows-2019
- windows-2022
steps:
- uses: actions/checkout@v4
- name: Run setup-nginx
uses: ./
id: nginx
with:
port: "8011"
- name: Run tests
run: |
values=(
'NGINX binary' 'bin' '${{ steps.nginx.outputs.bin }}'
'configuration file' 'conf-path' '${{ steps.nginx.outputs.conf-path }}'
'abs html dir path' 'html-dir' '${{ steps.nginx.outputs.html-dir }}'
'service port' 'port' '${{ steps.nginx.outputs.port }}'
'process ID' 'pid' '${{ steps.nginx.outputs.pid }}'
'access log file' 'access-log' '${{ steps.nginx.outputs.access-log }}'
'error log file' 'error-log' '${{ steps.nginx.outputs.error-log }}'
)
for ((i=0; i<${#values[@]}; i+=3)); do
echo "${values[$i+1]} = '${values[$i+2]}' (${values[$i]})"
done
# Add sample content to the html dir
echo "Hello, world!" > '${{ steps.nginx.outputs.html-dir }}/index.html'
echo "## Get the index.html file"
curl -sS http://localhost:${{ steps.nginx.outputs.port }}/
echo "## Get a non-existent file"
curl -sS http://localhost:${{ steps.nginx.outputs.port }}/foobar
echo "----------------------------------------"
# Test that each value is non-empty after curl is successful
for ((i=0; i<${#values[@]}; i+=3)); do
if [[ -z "${values[$i+2]}" ]]; then
echo "Value '${values[$i+1]}' is empty (${values[$i]})"
exit 1
fi
done
ACCESS_LOG="$(echo '${{ steps.nginx.outputs.access-log }}' | tr '\\' '/')"
ERROR_LOG="$(echo '${{ steps.nginx.outputs.error-log }}' | tr '\\' '/')"
if [[ ! -f "$ACCESS_LOG" ]]; then
echo "Access log file '$ACCESS_LOG' does not exist"
exit 1
fi
if [[ ! -f "$ERROR_LOG" ]]; then
echo "Error log file '$ERROR_LOG' does not exist"
exit 1
fi
echo "## Access log file:"
cat "$ACCESS_LOG"
echo "## Error log file:"
cat "$ERROR_LOG"
echo "----------------------------------------"
grep -q '127\.0\.0\.1.*GET /.* 200 ' "$ACCESS_LOG"
grep -q '127\.0\.0\.1.*GET /foobar.* 404 ' "$ACCESS_LOG"
index_html="$(curl -sSf http://localhost:${{ steps.nginx.outputs.port }}/)"
if [[ "Hello, world!" = "$index_html" ]]; then
echo "Content is correct"
else
echo "Expected content did not match the expected: 'Hello, world!'"
echo "Actual: '$index_html'"
exit 1
fi

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
tmp/

201
LICENSE-APACHE Normal file
View File

@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

21
LICENSE-MIT Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 Yuri Astrakhan <YuriAstrakhan@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

66
README.md Normal file
View File

@ -0,0 +1,66 @@
# GitHub Action: Setup NGINX
[![GitHub](https://img.shields.io/badge/github-nyurik/action--setup--nginx-8da0cb?logo=github)](https://github.com/nyurik/action-setup-nginx)
[![CI build](https://github.com/nyurik/action-setup-nginx/actions/workflows/ci.yml/badge.svg)](https://github.com/nyurik/action-setup-nginx/actions)
This action sets up a NGINX web server.
* Runs on Linux, macOS and Windows GitHub runners
* On Linux, assumes it is pre-installed
* On macOS, installs using [Homebrew](https://formulae.brew.sh/formula/nginx)
* On Windows, assumes it is pre-installed
* Configures the server with the provided configuration file content (if set)
* [Easy to check](action.yml) that IT DOES NOT contain malicious code.
## Usage
#### Input parameters
| Param | Description | Default |
|----------------|-----------------------------------------------------------------------------|---------|
| port | The port number to use for the NGINX service, unless conf-file-text is set. | 8080 |
| conf-file-text | Optional content of the nginx.conf file, overrides the default one | |
#### Outputs
| Value | Description |
|------------|---------------------------------------------------------------------------------------------|
| bin | The path to the NGINX binary. |
| conf-path | The path to the NGINX configuration file. |
| html-dir | Default directory NGINX service uses as the root. This can be overridden by conf-file-text. |
| pid | The process ID of the NGINX service. |
| port | The port number used by the NGINX service. |
| access-log | The path to the NGINX access log file, unless conf-file-text is provided. |
| error-log | The path to the NGINX error log file, unless conf-file-text is provided. |
#### Basic
```yaml
steps:
- uses: nyurik/action-setup-nginx@v1
id: nginx
- run: |
echo "Hello, world!" > "${{ steps.nginx.outputs.html-dir }}/index.html"
curl http://localhost:${{ steps.nginx.outputs.port }}/
# Expected output: Hello, world!
cat "${{ steps.nginx.outputs.access-log }}"
# Expected to contain a line with GET / HTTP/1.1 200
```
## License
Licensed under either of
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the
Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.

276
action.yml Normal file
View File

@ -0,0 +1,276 @@
name: Setup NGINX service for Linux/macOS/Windows
author: Yuri Astrakhan
description: Setup and run NGINX server on all platforms.
branding:
icon: server
color: purple
inputs:
port:
description: The port number to use for the NGINX service, unless conf-file-text is set.
default: "8080"
required: false
conf-file-text:
description: The text of the entire configuration file to use for NGINX. This will ignore some other inputs.
default: ""
required: false
outputs:
bin:
description: The path to the NGINX binary.
value: ${{ steps.detect_config.outputs.nginx_bin }}
conf-path:
description: The path to the NGINX configuration file.
value: ${{ steps.detect_config.outputs.conf_file }}
html-dir:
description: Default directory NGINX service uses as the root. This can be overridden by conf-file-text.
value: ${{ steps.detect_config.outputs.html_dir }}
pid:
description: The process ID of the NGINX service.
value: ${{ steps.detect_status.outputs.pid }}
port:
description: The port number used by the NGINX service.
value: ${{ steps.detect_status.outputs.port }}
access-log:
description: The path to the NGINX access log file, unless conf-file-text is provided.
value: ${{ steps.detect_config.outputs.access_log }}
error-log:
description: The path to the NGINX error log file, unless conf-file-text is provided.
value: ${{ steps.detect_config.outputs.error_log }}
runs:
using: composite
steps:
- name: Install NGINX (Linux)
id: init_linux
if: runner.os == 'Linux'
shell: bash
run: |
echo "Init NGINX on ${{runner.os}} ${{runner.arch}} ${{runner.environment}} runner"
sudo systemctl status nginx || true
NGINX_BIN=$(which nginx)
nginx_info="$(sudo "$NGINX_BIN" -V 2>&1)"
echo "sudo $NGINX_BIN -V"
echo "$nginx_info"
nginx_prefix=$(echo "$nginx_info" | grep 'configure arguments:' | sed -n -e 's/.*--prefix=\(.*\)/\1/p' | cut -d' ' -f1)
[ -d "$nginx_prefix" ] || { echo "NGINX prefix directory $nginx_prefix could not be determined"; exit 1; }
echo "nginx_bin=$NGINX_BIN" >> $GITHUB_OUTPUT
CONF_FILE=$(sudo nginx -t 2>&1 | sed -n -e 's/.*configuration file \(.*\) test .*/\1/p' | head -1)
sudo chown -R $(whoami) $CONF_FILE
echo "conf_file=$CONF_FILE" >> $GITHUB_OUTPUT
echo "log_dir=/var/log/nginx" >> $GITHUB_OUTPUT
echo "html_dir=$nginx_prefix/html" >> $GITHUB_OUTPUT
- name: Install NGINX (macOS)
id: init_macos
if: runner.os == 'macOS'
shell: bash
run: |
echo "Init NGINX on ${{runner.os}} ${{runner.arch}} ${{runner.environment}} runner"
brew install nginx
brew services list | grep nginx
NGINX_BIN=$(which nginx)
nginx_info="$(sudo "$NGINX_BIN" -V 2>&1)"
echo "sudo $NGINX_BIN -V"
echo "$nginx_info"
nginx_prefix=$(echo "$nginx_info" | grep 'configure arguments:' | sed -n -e 's/.*--prefix=\(.*\)/\1/p' | cut -d' ' -f1)
[ -d "$nginx_prefix" ] || { echo "NGINX prefix directory $nginx_prefix could not be determined"; exit 1; }
echo "nginx_bin=$NGINX_BIN" >> $GITHUB_OUTPUT
CONF_FILE=$(sudo nginx -t 2>&1 | sed -n -e 's/.*configuration file \(.*\) test .*/\1/p' | head -1)
sudo chown -R $(whoami) $CONF_FILE
echo "conf_file=$CONF_FILE" >> $GITHUB_OUTPUT
echo "html_dir=$nginx_prefix/html" >> $GITHUB_OUTPUT
if [[ -d /usr/local/var/log/nginx ]]; then
echo "log_dir=/usr/local/var/log/nginx" >> $GITHUB_OUTPUT
else
echo "log_dir=/opt/homebrew/var/log/nginx" >> $GITHUB_OUTPUT
fi
- name: Install NGINX (Windows)
id: init_windows
if: runner.os == 'Windows'
shell: pwsh
run: |
Write-Output "Init NGINX on ${{runner.os}} ${{runner.arch}} ${{runner.environment}} runner"
Get-Service nginx -ErrorAction SilentlyContinue
$nginx_root = Join-Path "C:\tools\" (Get-Item C:\tools\nginx*).Name
$nginx_bin = Join-Path $nginx_root "nginx"
$conf_file = Join-Path $nginx_root "\conf\nginx.conf"
& $nginx_bin -V
Add-Content -Path $env:GITHUB_OUTPUT -Encoding utf8 -Value "nginx_root=$nginx_root"
Add-Content -Path $env:GITHUB_OUTPUT -Encoding utf8 -Value "nginx_bin=$nginx_bin"
Add-Content -Path $env:GITHUB_OUTPUT -Encoding utf8 -Value "conf_file=$conf_file"
Add-Content -Path $env:GITHUB_OUTPUT -Encoding utf8 -Value "log_dir=$nginx_root\logs"
Add-Content -Path $env:GITHUB_OUTPUT -Encoding utf8 -Value "html_dir=$nginx_root\html"
Get-Content -Path $env:GITHUB_OUTPUT
- name: NGINX info
id: detect_config
shell: bash
run: |
echo 'Detected NGINX configuration for ${{ runner.os }} ${{ runner.arch }} on ${{ runner.name }}:'
if [[ '${{ runner.os }}' == 'Linux' ]]; then
nginx_bin='${{ steps.init_linux.outputs.nginx_bin }}'
conf_file='${{ steps.init_linux.outputs.conf_file }}'
html_dir='${{ steps.init_linux.outputs.html_dir }}'
access_log='${{ steps.init_linux.outputs.log_dir }}/access.log'
error_log='${{ steps.init_linux.outputs.log_dir }}/error.log'
elif [[ '${{ runner.os }}' == 'macOS' ]]; then
nginx_bin='${{ steps.init_macos.outputs.nginx_bin }}'
conf_file='${{ steps.init_macos.outputs.conf_file }}'
html_dir='${{ steps.init_macos.outputs.html_dir }}'
access_log='${{ steps.init_macos.outputs.log_dir }}/access.log'
error_log='${{ steps.init_macos.outputs.log_dir }}/error.log'
elif [[ '${{ runner.os }}' == 'Windows' ]]; then
nginx_bin='${{ steps.init_windows.outputs.nginx_bin }}'
conf_file='${{ steps.init_windows.outputs.conf_file }}'
html_dir='${{ steps.init_windows.outputs.html_dir }}'
access_log='${{ steps.init_windows.outputs.log_dir }}\access.log'
error_log='${{ steps.init_windows.outputs.log_dir }}\error.log'
else
echo 'Unknown OS: ${{ runner.os }}'
exit 1
fi
echo '::group::Original NGINX config file'
cat "$conf_file"
echo '::endgroup::NGINX config file'
echo "nginx_bin=$nginx_bin" >> $GITHUB_OUTPUT
echo "conf_file=$conf_file" >> $GITHUB_OUTPUT
echo "html_dir=$html_dir" >> $GITHUB_OUTPUT
echo "access_log=$access_log" >> $GITHUB_OUTPUT
echo "error_log=$error_log" >> $GITHUB_OUTPUT
cat $GITHUB_OUTPUT
- name: Overwrite NGINX configuration file
if: inputs.conf-file-text != ''
shell: bash
run: |
echo "Overwrite NGINX config ${{ steps.detect_config.outputs.conf_file }} for ${{ runner.os }} ${{ runner.arch }} on ${{ runner.name }} with the value of the input parameter."
echo "${{ inputs.conf-file-text }}" > "${{ steps.detect_config.outputs.conf_file }}"
- name: Create new NGINX configuration file
if: inputs.conf-file-text == ''
shell: bash
run: |
echo "Create new NGINX config ${{ steps.detect_config.outputs.conf_file }} for ${{ runner.os }} ${{ runner.arch }} on ${{ runner.name }}."
cat <<EOF > "${{ steps.detect_config.outputs.conf_file }}"
worker_processes 1;
events {
worker_connections 1024;
}
http {
include mime.types;
default_type application/octet-stream;
sendfile on;
keepalive_timeout 65;
server {
listen ${{ inputs.port }};
server_name localhost;
location / {
root html;
index index.html index.htm;
}
error_page 500 502 503 504 /50x.html;
location = /50x.html {
root html;
}
}
}
EOF
- name: Start NGINX (Linux)
if: runner.os == 'Linux'
id: start_linux
shell: bash
run: |
echo "Start NGINX ${{ steps.detect_config.outputs.nginx_bin }} on ${{runner.os}} using ${{ steps.detect_config.outputs.conf_file }}"
echo "::group::New NGINX configuration"
sudo ${{ steps.detect_config.outputs.nginx_bin }} -T
echo "::endgroup::"
sudo systemctl start nginx
sleep 2 # TODO: wait for the service to start in a loop instead of hardcoding a delay
sudo systemctl status nginx || true
echo "pid=$(systemctl show -p MainPID nginx | cut -d= -f2)" >> $GITHUB_OUTPUT
echo "port=$(sudo netstat -tulnp | grep nginx | awk '{print $4}' | sed -n -e 's/.*:\([0-9]*\)/\1/p' | head -1)" >> $GITHUB_OUTPUT
- name: Start NGINX (macOS)
if: runner.os == 'macOS'
id: start_macos
shell: bash
run: |
echo "Start NGINX ${{ steps.detect_config.outputs.nginx_bin }} on ${{runner.os}} using ${{ steps.detect_config.outputs.conf_file }}"
echo "::group::New NGINX configuration"
sudo ${{ steps.detect_config.outputs.nginx_bin }} -T
echo "::endgroup::"
brew services list | grep nginx
# There are some issues with starting nginx on macOS, so we force sudo. Expert help is welcome.
sudo nginx
# brew services start nginx
sleep 2
brew services list | grep nginx
if [[ -d /usr/local/var/log/nginx ]]; then
echo "pid=$(cat /usr/local/var/run/nginx.pid)" >> $GITHUB_OUTPUT
else
echo "pid=$(cat /opt/homebrew/var/run/nginx.pid)" >> $GITHUB_OUTPUT
fi
echo "port=$(sudo lsof -iTCP -sTCP:LISTEN -n -P | grep nginx | awk '{print $9}' | cut -d':' -f2 | head -1)" >> $GITHUB_OUTPUT
- name: Start NGINX (Windows)
if: runner.os == 'Windows'
id: start_windows
shell: pwsh
run: |
Write-Output "Start NGINX ${{ steps.detect_config.outputs.nginx_bin }} on ${{runner.os}} using ${{ steps.detect_config.outputs.conf_file }}"
Write-Output "::group::New NGINX configuration"
pushd ${{ steps.init_windows.outputs.nginx_root }}
& ${{ steps.detect_config.outputs.nginx_bin }} -T
popd
Write-Output "::endgroup::"
Set-Service nginx -StartupType manual
Start-Service nginx
Start-Sleep -Seconds 5
Get-Service nginx
Get-Process -Name nginx
$processes = Get-Process -Name nginx
$found = $false
foreach ($process in $processes) {
$connections = Get-NetTCPConnection -OwningProcess $process.Id -State Listen -ErrorAction SilentlyContinue
if ($?) {
foreach ($connection in $connections) {
if ($connection) {
Add-Content -Path $env:GITHUB_OUTPUT -Encoding utf8 -Value "pid=$($process.Id)"
Add-Content -Path $env:GITHUB_OUTPUT -Encoding utf8 -Value "port=$($connection.LocalPort)"
$found = $true
break
}
}
if ($found) {
break
}
}
}
Get-Content -Path $env:GITHUB_OUTPUT
- name: Output NGINX info
id: detect_status
shell: bash
run: |
echo "NGINX service was started for ${{ runner.os }} ${{ runner.arch }} on ${{ runner.name }}"
if [[ "${{ runner.os }}" == "Linux" ]]; then
echo "pid=${{ steps.start_linux.outputs.pid }}" >> $GITHUB_OUTPUT
echo "port=${{ steps.start_linux.outputs.port }}" >> $GITHUB_OUTPUT
elif [[ "${{ runner.os }}" == "macOS" ]]; then
echo "pid=${{ steps.start_macos.outputs.pid }}" >> $GITHUB_OUTPUT
echo "port=${{ steps.start_macos.outputs.port }}" >> $GITHUB_OUTPUT
elif [[ "${{ runner.os }}" == "Windows" ]]; then
echo "pid=${{ steps.start_windows.outputs.pid }}" >> $GITHUB_OUTPUT
echo "port=${{ steps.start_windows.outputs.port }}" >> $GITHUB_OUTPUT
else
exit 1
fi
cat $GITHUB_OUTPUT