lumarel/toolkit
1
0
Fork 0
forked from sig_core/toolkit
Code Issues Pull Requests Packages Projects Releases Wiki Activity
0ad6773539
toolkit/README.md
Louis Abel bb2c8d1965
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 02:05:53 -07:00

1.5 KiB
Raw Blame History

sig-core-toolkit

Release Engineering toolkit for repeatable operations or functionality testing.

Currently mirrored at our github, and the RESF Git Service. Changes will typically occur at the RESF Git Service.

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.
  • mangle -> Manglers and other misc stuff
  • sync -> Sync tools, primarily for Rocky Linux 8 and will eventually be deprecated

How can I help?

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

  • 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.

Your PR should be against the devel branch at all times. PR's against the main branch will be closed.

Will some of this be moved into separate repositories?

There may be some things that will be moved to its own repository in the near 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.