Skip to content
This repository has been archived by the owner on Aug 18, 2023. It is now read-only.

Commit

Permalink
README | Fix repo refs, link to workflow results
Browse files Browse the repository at this point in the history
- Fix repo references (use "upstream" instead of my fork)
- Add CI badge for "CI PR runner"
- Update badges to link to workflow results

refs rsyslogGH-121
  • Loading branch information
atc0005 committed Aug 26, 2020
1 parent aa52987 commit 97b6931
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
rsyslog-pkg-ubuntu
==================

<!--
FIXME: Reference the upstream repo instead of this forked/testing repo when submitting upstream
-->
![Install rsyslog packages from OBS](https://github.com/atc0005/rsyslog-pkg-ubuntu/workflows/Install%20rsyslog%20packages%20from%20OBS/badge.svg?branch=master)
![Install rsyslog packages from PPA](https://github.com/atc0005/rsyslog-pkg-ubuntu/workflows/Install%20rsyslog%20packages%20from%20PPA/badge.svg)

[![CI PR runner](https://github.com/rsyslog/rsyslog-pkg-ubuntu/workflows/CI%20PR%20runner/badge.svg)](https://github.com/rsyslog/rsyslog-pkg-ubuntu/actions?query=workflow%3A%22CI+PR+runner%22)
[![Install rsyslog packages from OBS](https://github.com/rsyslog/rsyslog-pkg-ubuntu/workflows/Install%20rsyslog%20packages%20from%20OBS/badge.svg?branch=master)](https://github.com/rsyslog/rsyslog-pkg-ubuntu/actions?query=workflow%3A%22Install+rsyslog+packages+from+OBS%22)
[![Install rsyslog packages from PPA](https://github.com/rsyslog/rsyslog-pkg-ubuntu/workflows/Install%20rsyslog%20packages%20from%20PPA/badge.svg)](https://github.com/rsyslog/rsyslog-pkg-ubuntu/actions?query=workflow%3A%22Install+rsyslog+packages+from+PPA%22)

This respository contains the sources needed to build Ubuntu rsyslog
packages. It is our goal to create the best possible packages for
Expand Down Expand Up @@ -102,7 +99,7 @@ How to install
1. Open a Terminal
2. Enter the following command:
```
sudo add-apt-repository ppa:adiscon/v8-stable
sudo add-apt-repository ppa:adiscon/v8-stable
```
3. Then update your apt cache:
```
Expand Down Expand Up @@ -144,7 +141,7 @@ immediate helpers, like librelp. It may also contain the necessary things
to build packages for non-close helpers if they fulful the criteria layed
out at the top of the page.

Each package has its own directory in the top directory. Each of them
Each package has its own directory in the top directory. Each of them
contains a directory named "common" and directories for the specific
Ubuntu branches (like trusty or precise). The idea here is that we have a
lot of information that is common to all Ubuntu versions. In order to
Expand All @@ -167,7 +164,7 @@ and especially the newer ones. So we may need to migrate some stuff from
override). This approach will enable us to keep up with Ubuntu development.

From time to time, we should evaluate if the "common"/"ubuntu-ver" override
mechanism actually provides benefit over just keeping everything in
mechanism actually provides benefit over just keeping everything in
"ubuntu-ver". If there are no compelling benefits, we may want to go to
an "ubuntu-ver", only approach. Note, thought, that pre-2015 we had such
an "ubuntu-ver" only approach and it lead to delays when new Ubuntu versions
Expand Down Expand Up @@ -204,18 +201,18 @@ possible, but requires more editing work.

In general, control files in all Ubuntu versions need to be edited for
all versions we maintain. For the current build, with rsyslog, this
usually means you need to edit v8-stable and master, as well as
usually means you need to edit v8-stable and master, as well as
v7-stable, as long as we maintain it for the platform. As v7-stable
will not receive updates any longer, you usually do not need to look
at that. If a new feature is added to master, you can edit it only
there, for obvious reasons. When this feature becomes released, you
can simply copy the master control files to v8-stable and are
(hopefully) set.
(hopefully) set.

If, however, something was forgotten (or we just discovered we could already
have done it), you need to edit all control files along all versions
supported. If there are e.g. 5 Ubuntu platforms and there are master,
v8-stable and v7-stable for all of them, that unfortunately means you
v8-stable and v7-stable for all of them, that unfortunately means you
need to apply the same edit 15 times in the case of rsyslog.
That's ugly, but the way it currently is. We are open to contributions
that make this easier (but please contribute code, not "just" ideas -
Expand Down

0 comments on commit 97b6931

Please sign in to comment.