diff --git a/docs/cli/validate-config.md b/docs/cli/config/validate.md similarity index 82% rename from docs/cli/validate-config.md rename to docs/cli/config/validate.md index 68670be018..57f09fa88c 100644 --- a/docs/cli/validate-config.md +++ b/docs/cli/config/validate.md @@ -1,16 +1,16 @@ --- -title: validate-config +title: validate date: 2021-03-18T08:48:36+01:00 sidebar_position: 30 --- -# `packit validate-config` +# `packit config validate` Validate the Packit configuration file. ## Help - Usage: packit validate-config [OPTIONS] [PATH_OR_URL] + Usage: packit config validate [OPTIONS] [PATH_OR_URL] Validate PackageConfig. diff --git a/docs/cli/index.md b/docs/cli/index.md index 13fbf3ff73..518f27ccb0 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -99,7 +99,7 @@ configuration files, like in the following examples: * [srpm](/docs/cli/srpm/) * [status](/docs/cli/status) * [sync-from-downstream](/docs/cli/sync-from-downstream/) -* [validate-config](/docs/cli/validate-config) +* [config validate](/docs/cli/config/validate) * [source-git init](/docs/cli/source-git/init) * [source-git update-dist-git](/docs/cli/source-git/update-dist-git) * [source-git update-source-git](/docs/cli/source-git/update-source-git) diff --git a/docs/configuration/downstream_configuration_template.md b/docs/configuration/downstream_configuration_template.md index 97c2d25b6a..53c38dc3e8 100644 --- a/docs/configuration/downstream_configuration_template.md +++ b/docs/configuration/downstream_configuration_template.md @@ -10,7 +10,7 @@ This is a template for configuration of Packit's Fedora release automation (dist 2. create a `packit.yaml`/`.packit.yaml` file in root directory of your dist-git repository in your `rawhide` branch and paste the content 3. resolve the TODOs -4. (optionally) run [`packit validate-config`](/docs/cli/validate-config) to make sure the configuration is valid +4. (optionally) run [`packit config validate`](/docs/cli/config/validate) to make sure the configuration is valid ## Template ```yaml diff --git a/docs/fedora-releases-guide/dist-git-onboarding.md b/docs/fedora-releases-guide/dist-git-onboarding.md index 8c23cfc386..a12fc44863 100644 --- a/docs/fedora-releases-guide/dist-git-onboarding.md +++ b/docs/fedora-releases-guide/dist-git-onboarding.md @@ -52,7 +52,7 @@ Packit dist-git configuration. :::tip Configuration validation For validation of the configuration, you can utilise -Packit CLI command [`validate-config`](/docs/cli/validate-config) or our +Packit CLI command [`config validate`](/docs/cli/config/validate) or our [pre-commit hooks](/posts/pre-commit-hooks#validate-config). ::: diff --git a/docs/fedora-releases-guide/what-to-know.md b/docs/fedora-releases-guide/what-to-know.md index 563002112b..4e07073034 100644 --- a/docs/fedora-releases-guide/what-to-know.md +++ b/docs/fedora-releases-guide/what-to-know.md @@ -68,7 +68,7 @@ During service outages, maintain workflow using Packit CLI: 2. [Configure required tokens](https://packit.dev/docs/configuration#user-configuration-file) 3. Verify setup (if not already working in service): - Follow [dist-git onboarding guide](https://packit.dev/docs/fedora-releases-guide/dist-git-onboarding) - - Validate config with `packit validate-config` + - Validate config with `packit config validate` #### Troubleshooting Issues diff --git a/docs/guide.md b/docs/guide.md index f38f8a5700..8f6b9533a0 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -246,7 +246,7 @@ For downstream jobs, Packit always loads the config from the default branch of t :::tip For validation of the configuration, you can utilise -Packit CLI command [`validate-config`](/docs/cli/validate-config) or our +Packit CLI command [`config validate`](/docs/cli/config/validate) or our [pre-commit hooks](/posts/pre-commit-hooks#validate-config). ::: diff --git a/posts/pre-commit-hooks/index.md b/posts/pre-commit-hooks/index.md index 5a8e621b1d..1f2302cc50 100644 --- a/posts/pre-commit-hooks/index.md +++ b/posts/pre-commit-hooks/index.md @@ -46,7 +46,7 @@ To try, add this to your `.pre-commit-config.yaml` Packit uses a [YAML configuration file](https://packit.dev/docs/configuration) in an upstream repository. -We have a [packit validate-config](https://packit.dev/docs/cli/validate-config) command +We have a [packit config validate](https://packit.dev/docs/cli/config/validate) command to check it, but it's easy to forget (to run it) and notice a typo after you committed and pushed the changes and waited for some time for Packit to tell you that in a PR. @@ -57,7 +57,7 @@ It's much faster to catch the problem before committing and/or pushing the chang This hook runs (only if there's been a change in the `.packit.yaml`) `packit` in a container (from [our image](https://quay.io/repository/packit/packit)), -mounts your sources inside and runs the `packit validate-config`. +mounts your sources inside and runs the `packit config validate`. ```yaml - repo: https://github.com/packit/pre-commit-hooks