gregory/docs/config-reference.md

Config Reference

• Default config location: gregory.toml
• Example: see gregory.example.toml

It's recommended to edit the config file using Even Better TOML for VS Code with the following options:

    "evenBetterToml.formatter.indentTables": true,
    "evenBetterToml.formatter.indentString": "  "

Note: This primarily uses LibreWolf and Fedora as examples of packages and distros. Also note that rather than separating by what distro, you can instead use those field to define which repo.

Top-level config

• max-threads (float): The maximum number of threads to be used
  • See also: threads
  • Default is CPU's threads - 2
• max-jobs (integer): The maximum number of jobs to be run at once
  • Default is 1
• data-dir (string): The path to put data for job logs and stuff
  • Temporary, will be removed once SQL database support is added

Multithreading notes (IMPORTANT): Gregory will first run compilation jobs, then packaging jobs for whatever programs are done, then run the update-repo for whichever distros are finished. For this reason, the distro names listed under packaging and update-repo must match.

Multithreading is not implemented yet

Job config

• revision (string): A revision id for the job, such as a version number for a compilation script
  • Default is 1
• threads (float): The maximum number of vCPUs/threads to dedicate to a job; this can be a fractional number
  • Set this as less than or equal to the max number of threads the thing you're running will use
  • See --cpus in the podman run docs
  • Root may be required for this argument
  • If not specified, it will fall back to max-threads
• image (string): The Docker image to run the job in (required)
• commands (array): The commands to run (required)
  • Note than you can use single-quote strings instead for string literals - see TOML docs for details
• volumes (array): Names of volumes as defined in volumes (top level)
• privileged (bool): Whether the job's container should be privileged
• shell (string): The shell to run the commands in
  • Default: /bin/sh

Packages (packages)

Example:

[packages]

  [packages.librewolf]

    dependencies = ["some-librewolf-dependency"]
    version_check = ["check-version --whenever-you-feel-like-it-please"]

    [packages.librewolf.compilation]
    revision = "2"
    threads = 8
    image = "docker.io/library/debian"
    commands = ["echo hi", "echo helloooooooooo"]
    volumes = ["librewolf"]

    [packages.librewolf.packaging.fedora]
    threads = 8
    image = "docker.io/library/fedora"
    commands = [
      "echo did you ever hear the tragedy of darth plageuis the wise?",
      "echo it\\'s not a story the jedi would tell you",
    ]
    volumes = ["librewolf"]

packages contains the following fields:

• dependencies (array): Lists dependencies for this package which gregory manages - don't list external dependencies in that field. This isn't required, but will ensure that gregory doesn't have to be run multiple times to get a package up-to-date.
  • Note that the repo will be updated ([update-repo]) after any dependency it updated
• version-check (array): Commands to be run to check the version of the package; what's printed to stdout will be counted as the version, and if anything is printed to stderr, the package will be ignored and an error will be logged. Additionally, if the package version seems to have decreased, then a warning will be logged.

Compilation (optional)

Defines the compilation of a program, if applicable. Stuff like Python scripts can skip this.

It's defined in this format:

[packages]

  [packages.librewolf]

    [packages.librewolf.compilation]
    revision = "2"
    threads = 8
    image = "docker.io/library/debian"
    commands = ["echo hi", "echo helloooooooooo"]
    volumes = ["librewolf"]

Packaging

Defines the packaging of a program into stuff like .deb or .rpm files.

Example:

[packages.librewolf.packaging.fedora]
threads = 8
image = "docker.io/library/fedora"
commands = [
  "echo did you ever hear the tragedy of darth plageuis the wise?",
  "echo it\\'s not a story the jedi would tell you",
]
volumes = ["librewolf"]

[packages.librewolf.packaging.debian]
threads = 4
image = "docker.io/library/debian"
commands = [
  "echo hiiiiiii"
]

Replace distro-name with the name of a distro, like fedora or debian

Update repo (update-repo)

Defines how to update a repo.

Example:

[update-repo]

  [update-repo.fedora]
  threads = 4
  image = 'docker.io/library/fedora'
  commands = ["echo hai"]
  volumes = ["librewolf"]

Volumes

Lists a volume in Docker/Podman's volume format, to be used in job configs

[volumes]
librewolf = "./local/path:/path-in-container"