forked from sig_core/toolkit
fix up readme, disable gitlab tests for now
This commit is contained in:
parent
f342046f25
commit
1a04399851
@ -3,10 +3,8 @@ sig-core-toolkit
|
||||
|
||||
Release Engineering toolkit for repeatable operations or functionality testing.
|
||||
|
||||
Currently mirrored at our [github](https://github.com/rocky-linux),
|
||||
[Rocky Linux Git Service](https://git.rockylinux.org), and the
|
||||
[RESF Git Service](https://git.resf.org). Changes either occur at the Rocky
|
||||
Linux Git Service or RESF Git Service.
|
||||
Currently mirrored at our [github](https://github.com/rocky-linux), and the
|
||||
[RESF Git Service](https://git.resf.org). Changes will typically occur at GitHub.
|
||||
|
||||
What does this have?
|
||||
--------------------
|
||||
@ -14,7 +12,7 @@ What does this have?
|
||||
* analyze -> Analysis utilities (such as download stats)
|
||||
* chat -> mattermost related utilities
|
||||
* func -> (mostly defunct) testing scripts and tools to test base functionality
|
||||
* iso -> ISO related utilities
|
||||
* iso -> ISO and Compose related utilities, primarily for Rocky Linux 9+
|
||||
* live -> Live image related utilities
|
||||
* mangle -> Manglers and other misc stuff
|
||||
* sync -> Sync tools, primarily for Rocky Linux 8
|
||||
|
@ -22,18 +22,24 @@ There should be additional logging regardless, not just to stdout, but also to a
|
||||
|
||||
## scripts
|
||||
|
||||
* sync-variant-pungi
|
||||
* sync-variant-peridot
|
||||
* sync-from-pungi
|
||||
* sync-from-peridot
|
||||
* sync-sig
|
||||
* build-all-iso
|
||||
* sign-repos-only
|
||||
```
|
||||
* sync_from_peridot -> Syncs repositories from Peridot
|
||||
* sync_sig -> Syncs SIG repositories from Peridot
|
||||
* build-iso -> Builds initial ISO's using Lorax
|
||||
* build-iso-extra -> Builds DVD's and other images based on Lorax data
|
||||
* launch-builds -> Creates a kube config to run build-iso
|
||||
* build-image -> Runs build-iso
|
||||
```
|
||||
|
||||
## wrappers
|
||||
|
||||
* lorax-generators
|
||||
* sync-generators
|
||||
```
|
||||
* common -> The starting point
|
||||
* iso_utils -> Does work for ISO building and generation
|
||||
* dnf_utils -> Does work for repo building and generation
|
||||
* check -> Checks if the architecture/release combination are valid
|
||||
* shared -> Shared utilities between all wrappers
|
||||
```
|
||||
|
||||
## rules
|
||||
|
||||
@ -43,8 +49,9 @@ When making a script, you *must* import common. This is insanely bad practice,
|
||||
but we would prefer if we started out this way:
|
||||
|
||||
```
|
||||
from common import *
|
||||
import argparse
|
||||
from empanadas.common import *
|
||||
from empanadas.util import Checks
|
||||
```
|
||||
|
||||
Whatever is imported in common will effectively be imported in your scripts as
|
||||
|
Loading…
Reference in New Issue
Block a user