Skip to content
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 37 additions & 4 deletions .github/workflows/builds.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1318,9 +1318,6 @@ jobs:
name: dist
- run: tar xf suricata-*.tar.gz --strip-components=1

- name: Update packages and install sudo
run: dnf -y update && dnf install -y sudo

- name: Install AlmaLinux 9 extra repositories
run: |
dnf -y update
Expand Down Expand Up @@ -2831,7 +2828,43 @@ jobs:
- run: apt update -y && apt install -y sudo

- name: Install minimal dependencies
run: ./scripts/docs-ubuntu-debian-minimal-build.sh
run: ./scripts/docs-ubuntu-minimal-build.sh

# Set the path, the export in the example script does not work
# in GitHub actions.
- run: echo "/usr/lib/rust-1.89/bin:$PATH" >> $GITHUB_PATH

- run: CFLAGS="${DEFAULT_CFLAGS}" ./configure
- run: make -j ${{ env.CPUS }}
- run: ./src/suricata --build-info # check if we can run Suricata

debian-13-minimal-recommended-build:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we could remove some builders because they do not bring any value...

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we could remove some builders because they do not bring any value...

Yeah, probably. Killed one off a couple weeks ago as its just required a few lines added to another similar build. Probably many more like this.

But this one tests documentation as well for a popular distro, so some are hard to get rid off, even if they don't do much different than another build.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was a general idea, not criticizing this PR

name: Debian 13 (Minimal/Recommended Build)
needs: [ubuntu-22-04-dist]
runs-on: ubuntu-latest
container: debian:13
steps:
# Cache Rust stuff.
- name: Cache cargo registry
uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb
with:
path: ~/.cargo/registry
key: cargo-registry

- name: Determine number of CPUs
run: echo CPUS=$(nproc --all) >> $GITHUB_ENV

- name: Download suricata.tar.gz
uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3
with:
name: dist
- run: tar xvf suricata-*.tar.gz --strip-components=1

# Install packages required by the install script.
- run: apt update -y && apt install -y sudo

- name: Install minimal dependencies
run: ./scripts/docs-debian-minimal-build.sh

- run: CFLAGS="${DEFAULT_CFLAGS}" ./configure
- run: make -j ${{ env.CPUS }}
Expand Down
3 changes: 2 additions & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ EXTRA_DIST = ChangeLog COPYING LICENSE suricata.yaml.in \
acsite.m4 \
scripts/generate-images.sh \
scripts/docs-almalinux9-minimal-build.sh \
scripts/docs-ubuntu-debian-minimal-build.sh \
scripts/docs-debian-minimal-build.sh \
scripts/docs-ubuntu-minimal-build.sh \
scripts/evedoc.py \
examples/plugins
SUBDIRS = rust src plugins qa rules doc etc python ebpf \
Expand Down
19 changes: 15 additions & 4 deletions doc/userguide/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,24 @@ Common configure options
Dependencies and compilation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Ubuntu/Debian
"""""""""""""
Debian 13+
""""""""""

.. note:: The following instructions require ``sudo`` to be installed.

.. literalinclude:: ../../scripts/docs-ubuntu-debian-minimal-build.sh
:caption: Minimal dependencies for Ubuntu/Debian
.. literalinclude:: ../../scripts/docs-debian-minimal-build.sh
:caption: Minimal dependencies for Debian
:language: bash
:start-after: # install-guide-documentation tag start: Minimal dependencies
:end-before: # install-guide-documentation tag end: Minimal dependencies

Ubuntu
""""""

.. note:: The following instructions require ``sudo`` to be installed.

.. literalinclude:: ../../scripts/docs-ubuntu-minimal-build.sh
:caption: Minimal dependencies for Ubuntu
:language: bash
:start-after: # install-guide-documentation tag start: Minimal dependencies
:end-before: # install-guide-documentation tag end: Minimal dependencies
Expand Down
1 change: 0 additions & 1 deletion scripts/docs-almalinux9-minimal-build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
# Serves for RPM-based docs and is verified by Github Actions

# install-guide-documentation tag start: Minimal RPM-based dependencies
sudo dnf install -y dnf-plugins-core epel-release
sudo dnf install -y cargo gcc jansson-devel libpcap-devel \
libyaml-devel make pcre2-devel zlib-devel
# install-guide-documentation tag end: Minimal RPM-based dependencies
10 changes: 10 additions & 0 deletions scripts/docs-ubuntu-minimal-build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#!/bin/bash

# Serves for Ubuntu/Debian docs and is verified by Github Actions

# install-guide-documentation tag start: Minimal dependencies
sudo apt -y install autoconf automake build-essential cargo-1.89 \
libjansson-dev libpcap-dev libpcre2-dev libtool \
libyaml-dev make pkg-config zlib1g-dev
export PATH=/usr/lib/rust-1.89/bin:$PATH
# install-guide-documentation tag end: Minimal dependencies