toolkit/README.md

44 lines
1.6 KiB
Markdown
Raw Normal View History

2021-07-05 06:50:25 +00:00
sig-core-toolkit
================
Release Engineering toolkit for repeatable operations or functionality testing.
Currently mirrored at our [github](https://github.com/rocky-linux), and the
2022-07-12 00:32:47 +00:00
[RESF Git Service](https://git.resf.org). Changes will typically occur at the
RESF Git Service.
2022-06-09 03:09:07 +00:00
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 -> Contains `empanadas`, which provides ISO, Compose, and Sync related utilities.
2022-06-09 03:09:07 +00:00
* mangle -> Manglers and other misc stuff
* sync -> Sync tools, primarily for Rocky Linux 8 and will eventually be deprecated
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:
2023-01-09 17:32:45 +00:00
* Your PR should be against the devel branch (not optional)
* Have pre-commit installed if possible
* Have shellcheck installed if possible
2022-06-09 03:09:07 +00:00
* Shell Scripts: These must pass a shellcheck test!
* Python scripts: Try your best to follow PEP8 guidelines (even the best linters get things wrong)
2022-06-09 03:09:07 +00:00
* Note that not everything has to pass. Just try your best.
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).
2022-06-09 03:09:07 +00:00
Will some of this be moved into separate repositories?
------------------------------------------------------
2021-07-05 06:50:25 +00:00
There may be some things that will be moved to its own repository in the near
2022-06-09 03:09:07 +00:00
future. From a SIG/Core standpoint, we believe a good chunk of this should stay
here as it makes it easier for us to maintain and manage.