toolkit/README.md

Empanadas
================

Empanadas is the Rocky Linux Release Engineering toolkit for repeatable operations or functionality testing.

<center><img src='.github/empanadas.png' width=150px /></center>

Currently mirrored at our [github](https://github.com/rocky-linux), and the
[RESF Git Service](https://git.resf.org). Changes will typically occur at the
RESF Git Service.

What does this have?
--------------------

* analyze -> Analysis utilities (such as download stats)
* chat -> mattermost related utilities
* iso -> Contains `empanadas`, which provides ISO, Compose, and Sync related utilities.
* mangle -> Manglers and other misc stuff
* sync -> Sync tools, used to sync from compose directories to mirror for Rocky Linux

How can I help?
---------------

Fork this repository and open a PR with your changes. Keep these things in mind
when you make changes:

* Your PR should be against the devel branch (not optional)
* Have pre-commit installed if possible
* Have shellcheck installed if possible
* Shell Scripts: These must pass a shellcheck test!
* Python scripts: Try your best to follow PEP8 guidelines (even the best linters get things wrong)

  * Note that not everything has to pass. Just try your best.

PR's against the main branch will be closed.

PR's are preferred at the [RESF Git Service](https://git.resf.org).
chore: update readme to reflect toolkit name We spend a lot of time beating around the bush, but the toolkit is essentially the sum of all the things in here -- we should accept that and just call it all Empanadas and work on cleaning up and having a better strategy around how we're doing development work in this repo including cutting releases. 2024-08-15 03:14:32 +00:00			`Empanadas`
Initial commit 2021-07-05 06:50:25 +00:00			`================`

chore: update readme to reflect toolkit name We spend a lot of time beating around the bush, but the toolkit is essentially the sum of all the things in here -- we should accept that and just call it all Empanadas and work on cleaning up and having a better strategy around how we're doing development work in this repo including cutting releases. 2024-08-15 03:14:32 +00:00			`Empanadas is the Rocky Linux Release Engineering toolkit for repeatable operations or functionality testing.`

			`<center><img src='.github/empanadas.png' width=150px /></center>`
Initial commit 2021-07-05 06:50:25 +00:00
fix up readme, disable gitlab tests for now 2022-06-28 19:41:12 +00:00			`Currently mirrored at our [github](https://github.com/rocky-linux), and the`
make a correction on the readme 2022-07-12 00:32:47 +00:00			`[RESF Git Service](https://git.resf.org). Changes will typically occur at the`
			`RESF Git Service.`
add forcearch to drive the point home 2022-06-09 03:09:07 +00:00
			`What does this have?`
			`--------------------`

			`* analyze -> Analysis utilities (such as download stats)`
			`* chat -> mattermost related utilities`
General Changes * Remove live directory as empanadas handles it * update readmes accordingly * add a quick-bump script for bumping release tags quickly 2022-12-20 09:05:53 +00:00			* iso -> Contains `empanadas`, which provides ISO, Compose, and Sync related utilities.
add forcearch to drive the point home 2022-06-09 03:09:07 +00:00			`* mangle -> Manglers and other misc stuff`
Changes (see notes) * Bump empanadas to 0.7.0 * Archive and remove `func` as testing team should be handling these components with tmt and openqa * Remove unused scripts from sync 2024-08-15 04:08:06 +00:00			`* sync -> Sync tools, used to sync from compose directories to mirror for Rocky Linux`
add forcearch to drive the point home 2022-06-09 03:09:07 +00:00
			`How can I help?`
			`---------------`

			`Fork this repository and open a PR with your changes. Keep these things in mind`
			`when you make changes:`

clarify readme 2023-01-09 17:32:45 +00:00			`* Your PR should be against the devel branch (not optional)`
General Changes * Remove live directory as empanadas handles it * update readmes accordingly * add a quick-bump script for bumping release tags quickly 2022-12-20 09:05:53 +00:00			`* Have pre-commit installed if possible`
			`* Have shellcheck installed if possible`
add forcearch to drive the point home 2022-06-09 03:09:07 +00:00			`* Shell Scripts: These must pass a shellcheck test!`
Remove hardcodes, add in metadata * Remove hardcodes of "Rocky" to use "shortname" instead * Add in metadata 2022-07-01 20:09:52 +00:00			`* Python scripts: Try your best to follow PEP8 guidelines (even the best linters get things wrong)`
add forcearch to drive the point home 2022-06-09 03:09:07 +00:00
General Changes * Remove live directory as empanadas handles it * update readmes accordingly * add a quick-bump script for bumping release tags quickly 2022-12-20 09:05:53 +00:00			`* Note that not everything has to pass. Just try your best.`

clarify readme 2023-01-09 17:32:45 +00:00			`PR's against the main branch will be closed.`

			`PR's are preferred at the [RESF Git Service](https://git.resf.org).`
add forcearch to drive the point home 2022-06-09 03:09:07 +00:00