From 85e1e73ab6408a9ced6106cdffd55d129a3478b3 Mon Sep 17 00:00:00 2001 From: Skip Grube Date: Sun, 15 Oct 2023 19:29:47 -0400 Subject: [PATCH 1/3] Added mkdocs container stuff for local testing -Skip G. --- Dockerfile | 15 +++++++++++++++ docker-compose.yml | 12 ++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 Dockerfile create mode 100644 docker-compose.yml diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..9cc71d2 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,15 @@ +FROM rockylinux:9 + +RUN dnf update -y &&\ + dnf install -y git python3-pip &&\ + dnf clean all + +# bind volume $CWD > /wiki exists in docker-compose.yml +RUN mkdir /wiki +COPY requirements.txt /wiki +WORKDIR /wiki +RUN pip3 install -r requirements.txt + +EXPOSE 8000 +CMD mkdocs serve -a 0.0.0.0:8000 + diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..4243f9b --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,12 @@ +version: '3.2' +services: + wiki: + volumes: + - type: bind + source: . + target: /wiki + build: + context: . + ports: + - 8000:8000 + From a9d15ef50f68510d5157335db3a70308acedb165 Mon Sep 17 00:00:00 2001 From: Skip Grube Date: Sun, 15 Oct 2023 19:33:22 -0400 Subject: [PATCH 2/3] Added some initial content - Expansion of why the SIG exists, and what (in principle) it should host -Skip G. --- README.md | 4 ++++ docs/index.md | 39 ++++++++++++++++++++++++++++++++++----- 2 files changed, 38 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a346d99..93dbc23 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,7 @@ ## Continuous Integration / Continuous Deployment Actions Runner executes workflow to publish to https://sig-fasttrack.rocky.page on push to main. + +## Local testing + +A Dockerfile and docker-compose are included for local testing. "docker-compose up" (or "podman-compose up") should be enough to launch this wiki locally. Point your browser to http://localhost:8000 to view. diff --git a/docs/index.md b/docs/index.md index b6571b0..514d8ee 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,14 +1,43 @@ # SIG/FastTrack Wiki - FastTrack, as an ode to a past CentOS repository of a similar name, is a SIG to attempt to provide the following: +## A Package Bazaar, not a Package Cathedral + +FastTrack, as an ode to a past CentOS repository of a similar name, is a SIG that attempts to provide: + + * Fixes, customizations, upgrades, and improvements to existing Rocky packages that the community would like to see + * Backports of patches that may not be released by our upstreams (RHEL, CentOS Stream, or even Fedora) to address bugs or functionality + * New original packages for Rocky. It's possible new ones could eventually make it into CentOS Stream or EPEL. + * Newer major versions of software that override the base Rocky repositories - even versions so new they will likely never land in RHEL, CentOS Stream, or EPEL + + +## Philosophy + +The goal is to have a place in the Rocky project where experimental new packages and updates to existing ones can be published. Philosophically, this SIG should be wide open to contributions, with much less rigor or vetting than repositories such as EPEL. Newer versions of existing Rocky Linux packages, as well as brand new packages are both welcome. **We don't need reasons to add a package, we need reasons to *not* add it. + + +Having said that, we can't have absolute anarchy. There must be some kind of a guideline to what can and cannot be accepted. + +### Reasons for FastTrack Package Rejection: + +- **Broken dependencies:** `dnf repoclosure` must succeed on publication. If some packages are not installable under default Rocky Linux, we cannot include the package until that's fixed +- **Malicious or severe security risk:** We should not publish anything that presents a severe security risk to the user (think remotely-exploitable-by-default code). +- **Changes a core package in a questionable way:** Related to the security risk issue. We cannot override `openssl` or `glibc` with questionable behavior or API updates. "Core" is in the eye of the beholder, but generally we want FastTrack users to continue using the solid Rocky Linux base. +- **We don't have permssion to redistribute:** Self-explanatory. Contributions don't necessarily have to be 100% open source, but the Rocky project cannot and will not host copyrighted, non-redistributable content. +- **It already exists in EPEL, RPMFusion, or another 3rd-party repo**: The intention of this SIG is to provide as much "new and cool" stuff to Rocky Linux users as possible. If people can already get software from one of the popular 3rd-party repos, that's probably the best place to go. An exception to this is when dependencies are needed that already exist in another repo, that are needed to build the new package we want. +- **Package clearly belongs in another SIG:** The goal of this SIG is to be a "catchall" for desirable new packages or updates. However, many times a package clearly doesn't belong in FastTrack, but in another SIG already set up for that purpose. Enhanced kernels should probably go in SIG/Kernel, embedded or single-board specific packages should go in SIG/AltArch, etc. + + +Outside of these guidelines, package contributions should always be welcome! - * Fixes, customizations, improvements to packages that the community would like to see - * This also includes doing backports of patches that may not be released by our upstreams to address any type of bugs - * Potential packages that could potentially make it to CentOS Stream or EPEL - * Newer versions of software that override the base repositories that would likely never land in RHEL, CentOS Stream, or EPEL ## Links +- **SIG-FastTrack Wiki: ** https://sig-fasttrack.rocky.page/ +- **MatterMost Channel: ** https://chat.rockylinux.org/rocky-linux/channels/sig-fasttrack +- **FastTrack Git Group: ** https://git.resf.org/sig_fasttrack/ (New package requests can be in meta/, wiki source under wiki/ ) +- **FastTrack Package Sources: ** https://git.rockylinux.org/sig/fasttrack/ +- + ## Responsibilities ## Meetings / Communications From f0db04f6d8403d86163b26a458b4db777d4f8365 Mon Sep 17 00:00:00 2001 From: Skip Grube Date: Sun, 15 Oct 2023 23:41:37 -0400 Subject: [PATCH 3/3] Initial content commit - Including updated SIG introduction and info - Package Listing page - Repos + Package builds overview page - Minor mkdocs tweak for local wiki render -Skip G. --- docs/index.md | 11 ++++++----- docs/package_list/index.md | 23 +++++++++++++++++++++++ docs/repositories/index.md | 32 ++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 4 files changed, 62 insertions(+), 5 deletions(-) create mode 100644 docs/package_list/index.md create mode 100644 docs/repositories/index.md diff --git a/docs/index.md b/docs/index.md index 514d8ee..b875fa5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -32,11 +32,12 @@ Outside of these guidelines, package contributions should always be welcome! ## Links -- **SIG-FastTrack Wiki: ** https://sig-fasttrack.rocky.page/ -- **MatterMost Channel: ** https://chat.rockylinux.org/rocky-linux/channels/sig-fasttrack -- **FastTrack Git Group: ** https://git.resf.org/sig_fasttrack/ (New package requests can be in meta/, wiki source under wiki/ ) -- **FastTrack Package Sources: ** https://git.rockylinux.org/sig/fasttrack/ -- +- **SIG-FastTrack Wiki:** [https://sig-fasttrack.rocky.page/](https://sig-fasttrack.rocky.page/) +- **MatterMost Chat Channel:** [https://chat.rockylinux.org/rocky-linux/channels/sig-fasttrack](https://chat.rockylinux.org/rocky-linux/channels/sig-fasttrack) +- **FastTrack Git Group:** [https://git.resf.org/sig_fasttrack/](https://git.resf.org/sig_fasttrack/) (New package requests can be in meta/, wiki source under wiki/ ) +- **FastTrack Package Sources:** [https://git.rockylinux.org/sig/fasttrack/](https://git.rockylinux.org/sig/fasttrack/) +- **Peridot RPM Build System:** [https://peridot.build.resf.org/](https://peridot.build.resf.org/) + ## Responsibilities diff --git a/docs/package_list/index.md b/docs/package_list/index.md new file mode 100644 index 0000000..4c3e41f --- /dev/null +++ b/docs/package_list/index.md @@ -0,0 +1,23 @@ +--- +title: Package List +--- +# FastTrack Package List + + +## FastTrack-Updates + +| Package | Major Version | Reason | Extra Notes | Date Added | +|---------- | -------------- | -------- | ------------ | ---------- | +| | | | | | +| | | | | | +| | | | | | + + +## FastTrack-New + +| Package | Major Version | Reason | Extra Notes | Date Added | +|---------- | -------------- | -------- | ------------ | ---------- | +| | | | | | +| | | | | | +| | | | | | + diff --git a/docs/repositories/index.md b/docs/repositories/index.md new file mode 100644 index 0000000..3106cc3 --- /dev/null +++ b/docs/repositories/index.md @@ -0,0 +1,32 @@ +--- +title: Repositories and Packages +--- +# Repositories + +There are 2 main FastTrack repositories: **FastTrack-Updates** and **FastTrack-New** . + +The -Updates repository contains newer versions of packages found in Rocky Linux, while the -New repository is exclusively new packages. + +## Updates Repo: Includes and Excludes + +The FastTrack-Updates repository in particular could be an issue for some users - what if you are only interested in updating certain packages on your system, but leaving others alone? This is not a problem for FastTrack-New , as you can simply opt to not install packages you don't want. + +To assist users, the FastTrack.repo file will have a couple comments explaining how to `includepkgs` and `excludepkgs` in DNF. Specifying includepkgs allows users to only receive updates for the listed packages, while excludepkgs allows them to ignore FastTrack updates of things they prefer to keep on the stock Rocky ones. + + +# Packages + +## Suggestions/Requests + +New packages can always be discussed for inclusion via issues at: [https://git.resf.org/sig_fasttrack/meta/issues](https://git.resf.org/sig_fasttrack/meta/issues) + +The best/fastest way to get a package included in the SIG is to have the build pre-complete in tested. That is, have a working git repository or SRPM somewhere that you've confirmed builds properly against Rocky Linux. We can then bring the package into dist-git under https://git.rockylinux.org/sig/fasttrack/src/PACKAGE and build + publish in the Rocky build system. + + +## Builds +Package builds *must* build with Rocky Linux dependencies only. (BaseOS/AppStream/PowerTools/Devel/etc.) + +Using 3rd party repos such as EPEL as dependencies is not allowed. 3rd party repositories are subject to change, and we do not want to depend on external packages in order to use SIG-FastTrack. If a package is dependent on other packages found in EPEL or other repos, these dependencies can be re-built and made available in the FastTrack repositories as well. + +A standard Mock config will be made available in the SIG's Git space for each major version of Rocky Linux. These Mock configs will reflect the SIG's Peridot build settings, so proper apples-to-apples testing of builds can be done locally by contributors. + diff --git a/mkdocs.yml b/mkdocs.yml index 562e6f6..a43aab2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -62,6 +62,7 @@ plugins: - awesome-pages - git-revision-date-localized: type: date + fallback_to_build_date: true - search # Extensions