Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
47 changes: 33 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,48 @@
# <img src="https://raw.githubusercontent.com/itsallcode/openfasttrace/main/core/src/main/resources/openfasttrace_logo.svg" alt="OFT logo" width="150"/> OpenFastTrace Debian Package
# itsallcode.org APT Repository

This repository builds Debian packages for [OpenFastTrace](https://github.com/itsallcode/openfasttrace) (OFT), a requirement tracing suite. OFT keeps track of whether you implemented everything planned in your specifications and identifies obsolete parts of a product.
This repository contains the Debian packages published by [itsallcode.org](https://itsallcode.org). It is available as a signed APT archive at [`https://apt.itsallcode.org`](https://apt.itsallcode.org).

[![Build Debian package](https://github.com/itsallcode/itsallcode-apt-repository/actions/workflows/build.yml/badge.svg)](https://github.com/itsallcode/itsallcode-apt-repository/actions/workflows/build.yml)
## Install packages

## Getting the Package
Add the itsallcode.org signing key and APT source on Debian, Ubuntu, or another Debian-derived distribution:

Pre-built source and binary packages are available from the [GitHub releases](https://github.com/itsallcode/itsallcode-apt-repository/releases). Install the binary package with its Java runtime dependency:
```sh
sudo install --directory --mode=0755 /etc/apt/keyrings
curl --fail --silent --show-error --location \
https://apt.itsallcode.org/itsallcode-archive-keyring.asc \
| sudo gpg --dearmor --yes --output /etc/apt/keyrings/itsallcode-archive-keyring.gpg
echo 'deb [signed-by=/etc/apt/keyrings/itsallcode-archive-keyring.gpg] https://apt.itsallcode.org stable main' \
| sudo tee /etc/apt/sources.list.d/itsallcode.list > /dev/null
sudo apt update
```

Before trusting a newly downloaded key, verify its fingerprint against the [published fingerprint](https://apt.itsallcode.org/itsallcode-archive-keyring.fingerprint).

## Available packages

### OpenFastTrace

[OpenFastTrace](https://github.com/itsallcode/openfasttrace) is an example of software distributed through this repository. It is a requirements-tracing suite that helps teams identify unimplemented requirements and obsolete product parts.

Install it with:

```sh
sudo apt install ./openfasttrace_<version>-<package-revision>_all.deb
sudo apt install openfasttrace
```

Run OpenFastTrace with:
Start it or view its command-line help with:

```sh
oft --help
```

For OFT usage, including command-line options and requirement notation, see the upstream [user guide](https://github.com/itsallcode/openfasttrace/blob/main/doc/user_guide/user_guide.md).
For usage and requirement notation, see the [OpenFastTrace user guide](https://github.com/itsallcode/openfasttrace/blob/main/doc/user_guide/user_guide.md).

## Maintainers

## Building a Package
The published archive lives in [`apt-repository/`](apt-repository/). Its [README](apt-repository/README.md) describes the archive layout and visitor-facing installation page.

On Debian or a derived distribution, install the tools listed by the precondition check, then build a source package and its binary package for an upstream release:
The current packaging scripts build and stage OpenFastTrace packages. On Debian or a derived distribution, prepare the build environment and create a package release with:

```sh
./check-preconditions.sh
Expand All @@ -31,14 +51,13 @@ On Debian or a derived distribution, install the tools listed by the preconditio
./stage-apt-package.sh <version> [package-revision]
```

The build artifacts are placed in `out/`. The scripts download the specified OpenFastTrace source release, incorporate this repository's `debian/` packaging metadata, and build the package. `stage-apt-package.sh` validates the resulting source and binary packages, then copies them into the Debian archive pool under `apt-repository/` for inclusion in a package pull request.
Build artifacts are written to `out/`; the staging script validates the package files and places them in the archive pool for review and publication.

## Project Information
## Project information

* [OpenFastTrace upstream project](https://github.com/itsallcode/openfasttrace)
* [Upstream user guide](https://github.com/itsallcode/openfasttrace/blob/main/doc/user_guide/user_guide.md)
* [Package design](doc/design.md)
* [System requirements](doc/system_requirements.md)
* [Security policy](SECURITY.md)
* [Contributing guide](CONTRIBUTING.md)
* [Security policy](SECURITY.md)
* [Code of conduct](CODE_OF_CONDUCT.md)
12 changes: 6 additions & 6 deletions apt-repository/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenFastTrace APT Repository
# itsallcode.org APT Repository

This directory is the document root published at `https://apt.itsallcode.org/openfasttrace`. The visitor-facing installation page is [index.html](index.html).
This directory is the document root published at `https://apt.itsallcode.org`. The visitor-facing installation page is [index.html](index.html).

## Installation

Expand All @@ -9,15 +9,15 @@ Install the repository's public key in a dedicated keyring and add the signed re
```sh
sudo install --directory --mode=0755 /etc/apt/keyrings
curl --fail --silent --show-error --location \
https://apt.itsallcode.org/openfasttrace/itsallcode-archive-keyring.asc \
https://apt.itsallcode.org/itsallcode-archive-keyring.asc \
| sudo gpg --dearmor --yes --output /etc/apt/keyrings/itsallcode-archive-keyring.gpg
echo 'deb [signed-by=/etc/apt/keyrings/itsallcode-archive-keyring.gpg] https://apt.itsallcode.org/openfasttrace stable main' \
| sudo tee /etc/apt/sources.list.d/openfasttrace.list > /dev/null
echo 'deb [signed-by=/etc/apt/keyrings/itsallcode-archive-keyring.gpg] https://apt.itsallcode.org stable main' \
| sudo tee /etc/apt/sources.list.d/itsallcode.list > /dev/null
sudo apt update
sudo apt install openfasttrace
```

The public key fingerprint is published at `https://apt.itsallcode.org/openfasttrace/itsallcode-archive-keyring.fingerprint`. Check it before trusting a newly downloaded key.
The public key fingerprint is published at `https://apt.itsallcode.org/itsallcode-archive-keyring.fingerprint`. Check it before trusting a newly downloaded key.

It follows the Debian archive layout:

Expand Down
6 changes: 3 additions & 3 deletions apt-repository/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ <h2>Installing Packages From This Repository</h2>
<p>Install the archive key in a dedicated APT keyring.</p>
<pre>sudo install --directory --mode=0755 /etc/apt/keyrings
curl --fail --silent --show-error --location \
https://apt.itsallcode.org/openfasttrace/itsallcode-archive-keyring.asc \
https://apt.itsallcode.org/itsallcode-archive-keyring.asc \
| sudo gpg --dearmor --yes --output /etc/apt/keyrings/itsallcode-archive-keyring.gpg</pre>
</li>
<li>
<p>Add the signed repository source.</p>
<pre>echo 'deb [signed-by=/etc/apt/keyrings/itsallcode-archive-keyring.gpg] https://apt.itsallcode.org/openfasttrace stable main' \
| sudo tee /etc/apt/sources.list.d/openfasttrace.list &gt; /dev/null</pre>
<pre>echo 'deb [signed-by=/etc/apt/keyrings/itsallcode-archive-keyring.gpg] https://apt.itsallcode.org stable main' \
| sudo tee /etc/apt/sources.list.d/itsallcode.list &gt; /dev/null</pre>
</li>
<li>
<p>Update APT and install the package.</p>
Expand Down
Binary file added itsallcode-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.