Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add bindep for package dependencies #10474

Closed
wants to merge 1 commit into from
Closed

Add bindep for package dependencies #10474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions bindep.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# This file is meant to be used with bindep to help manage package
# dependencies. Please refer to the bindep documentation for more
# information:
# https://docs.opendev.org/opendev/bindep/latest/

# The default profile installs only the packages necessary to build
# the project.
cmake
make

openscap-utils [platform:rpm]
openscap-scanner [platform:rpm]
openscap-common [platform:dpkg]
# Required for RHEL-based systems with python2
PyYAML [(platform:rpm platform:base-py2)]
python3-PyYAML [(platform:rpm platform:base-py3)]
python3-yaml [(platform:dpkg platform:base-py3)]
python3-setuptools [platform:base-py3]
python3-jinja2 [platform:base-py3]
xsltproc [platform:dpkg]
libxml2-utils [platform:dpkg]
26 changes: 8 additions & 18 deletions docs/manual/developer/02_building_complianceascode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,30 +29,20 @@ less ~/OpenSCAP/STARTGUIDE.md

## Installing build dependencies

### Required Dependencies
On *Red Hat Enterprise Linux 7* make sure the packages `cmake`, `openscap-utils`,
`PyYAML`, `python-jinja2`, `python-setuptools` and their dependencies are installed:

```bash
yum install cmake make openscap-utils openscap-scanner PyYAML python-jinja2
```

On *Red Hat Enterprise Linux 8* and *Fedora* the package list is the same but python2 packages need to be replaced with python3 ones:
The project uses [bindep](https://docs.opendev.org/opendev/bindep/latest/) to
manage package dependencies. By default, the `bindep.txt` file is organized to
emit only the packages necessary to build the project. We will add additional
profiles to help maintain dependencies for development and testing in the
future.

```bash
yum install cmake make openscap-utils openscap-scanner python3-pyyaml python3-jinja2 python3-setuptools
```
### Required Dependencies

On *Ubuntu* and *Debian*, make sure the packages `libopenscap8`,
`libxml2-utils`, `python3-jinja2`, `python3-yaml`, `python3-setuptools`, `xsltproc` and their dependencies are
installed:
You can install the necessary dependencies to build the project using:

```bash
apt-get install cmake make libopenscap8 libxml2-utils ninja-build python3-jinja2 python3-yaml python3-setuptools xsltproc
rhmdnd marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I didn't think the ninja-build package was necessary by default (as noted further down in the documentation), so I didn't include it for the Debian-based systems.

Please correct me if I'm wrong though.

$ sudo [apt-get | yum] install $(bindep -b)
```

IMPORTANT: Version `1.0.8` or later of `openscap-utils` is required to build the content.

### Git (Clone the Repository)

Install git if you want to clone the GitHub repository to get the
Expand Down