4ea2915ef7
This commit changes our release process from the model of having a release commit (and pull request) which also updated the NEWS.md file and bumped the versions in the osbuild.spec and setup.py files to simply pushing a tag. After the tag (containing the release notes) is pushed, a GitHub composite action is triggered that creates a GitHub release with the contents of the git release tag. Furthermore the bumping of the version number now always has to happen directly after a release to avoid having to push a(n untested) commit to main for the release and this is also handled by the GitHub composite action. Finally packit pushes directly to dist-git now on pushing the release tag, so no pull-request needs to be reviewed and merged anymore.
82 lines
2.2 KiB
Markdown
82 lines
2.2 KiB
Markdown
OSBuild
|
|
=======
|
|
|
|
Build-Pipelines for Operating System Artifacts
|
|
|
|
OSBuild is a pipeline-based build system for operating system artifacts. It
|
|
defines a universal pipeline description and a build system to execute them,
|
|
producing artifacts like operating system images, working towards an image
|
|
build pipeline that is more comprehensible, reproducible, and extendable.
|
|
|
|
See the `osbuild(1)` man-page for details on how to run osbuild, the definition
|
|
of the pipeline description, and more.
|
|
|
|
### Project
|
|
|
|
* **Website**: <https://www.osbuild.org>
|
|
* **Bug Tracker**: <https://github.com/osbuild/osbuild/issues>
|
|
* **IRC**: #osbuild on [Libera.Chat](https://libera.chat/)
|
|
* **Changelog**: <https://github.com/osbuild/osbuild/releases>
|
|
|
|
#### Contributing
|
|
|
|
Please refer to the [developer guide](https://www.osbuild.org/guides/developer-guide/developer-guide.html) to learn about our workflow, code style and more.
|
|
|
|
### Requirements
|
|
|
|
The requirements for this project are:
|
|
|
|
* `bubblewrap >= 0.4.0`
|
|
* `python >= 3.7`
|
|
|
|
Additionally, the built-in stages require:
|
|
|
|
* `bash >= 5.0`
|
|
* `coreutils >= 8.31`
|
|
* `curl >= 7.68`
|
|
* `qemu-img >= 4.2.0`
|
|
* `rpm >= 4.15`
|
|
* `tar >= 1.32`
|
|
* `util-linux >= 235`
|
|
|
|
At build-time, the following software is required:
|
|
|
|
* `python-docutils >= 0.13`
|
|
* `pkg-config >= 0.29`
|
|
|
|
Testing requires additional software:
|
|
|
|
* `pytest`
|
|
|
|
### Install
|
|
|
|
Installing `osbuild` requires to not only install the `osbuild` module, but also
|
|
additional artifacts such as tools (i.e: `osbuild-mpp`) sources, stages, schemas
|
|
and SELinux policies.
|
|
|
|
For this reason, doing an installation from source is not trivial and the easier
|
|
way to install it is to create the set of RPMs that contain all these components.
|
|
|
|
This can be done with the `rpm` make target, i.e:
|
|
|
|
```sh
|
|
make rpm
|
|
```
|
|
|
|
A set of RPMs will be created in the `./rpmbuild/RPMS/noarch/` directory and can
|
|
be installed in the system using the distribution package manager, i.e:
|
|
|
|
```sh
|
|
sudo dnf install ./rpmbuild/RPMS/noarch/*.rpm
|
|
```
|
|
|
|
### Repository:
|
|
|
|
- **web**: <https://github.com/osbuild/osbuild>
|
|
- **https**: `https://github.com/osbuild/osbuild.git`
|
|
- **ssh**: `git@github.com:osbuild/osbuild.git`
|
|
|
|
### License:
|
|
|
|
- **Apache-2.0**
|
|
- See LICENSE file for details.
|