Skip to content

init.md

Latest commit

 

History

History
39 lines (28 loc) · 1.77 KB

init.md

File metadata and controls

39 lines (28 loc) · 1.77 KB
title sidebar_position
init
3

packit init

Initiate a repository to start using packit. By default this command adds .packit.yaml config file to the git repository in the current working directory.

If a .pre-commit-config.yaml file is found at the root of the git repository, init will add a pre-commit hook, which automatically runs packit config validate to check the validity of .packit.yaml upon pre-commit. Before adding this hook, init also checks for the presence of a .git repo. This behavior can be disabled using the --without-precommit flag.

In case .pre-commit-config.yaml is not found at the root of the repository, this behavior is skipped and can be forced using the --force-precommit flag. Please note that the two listed flags --without-precommit and --force-precommit are mutually exclusive.

If a spec file is found in the git repository, init will set specfile_path to point to it in .packit.yaml. Otherwise, specfile_path is set to <the name of the repository>.spec.

See source-git init if you want to initialize a source-git repo.

Help

Usage: packit init [OPTIONS] [PATH_OR_URL]

  Create the initial Packit configuration in a repository and add a pre-commit
  hook to validate Packit configuration file

  See 'packit source-git init', if you want to initialize a repository as a
  source-git repo.

Options:
  -f, --force          Reset config to default if already exists.
  --without-precommit  Skip adding packit-specific pre-commit configuration
                       hook.
  --force-precommit    Create pre-commit configuration file if missing.
  -h, --help           Show this message and exit.