Skip to content

Commit

Permalink
docs: drop misleading ... - pull from upstream examples (#766)
Browse files Browse the repository at this point in the history
docs: drop misleading `...` - pull from upstream examples

The ... is yaml syntax for indication of the end of the document.
https://yaml.org/spec/1.1/#document%20boundary%20marker/
The examples will result in a yaml parse error.
$ packit pull-from-upstream
2023-10-30 09:39:53.797 package_config.py ERROR  Cannot load package config /home/jamacku/Packages/fedora/forks/nghttp2/.packit.yml.
2023-10-30 09:39:53.797 package_config.py ERROR    parser says
  in "<unicode string>", line 5, column 1:
    jobs:
    ^
  expected '<document start>', but found '<block mapping start>'
2023-10-30 09:39:53.797 utils.py          ERROR  Please correct data and retry.

Reviewed-by: Laura Barcziová
  • Loading branch information
softwarefactory-project-zuul[bot] authored Nov 22, 2023
2 parents 09f4792 + 4c435bb commit bd8ef21
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/configuration/downstream/pull_from_upstream.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ You can also append `&component={your-package-name}` to the query above to const

```yaml
upstream_project_url: https://github.com/packit/packit
...

jobs:
- job: pull_from_upstream
trigger: release
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ do not change it.

```yaml
upstream_project_url: https://github.com/packit/packit
...
jobs:
- job: pull_from_upstream
trigger: release
Expand All @@ -552,7 +552,7 @@ jobs:

```yaml
upstream_project_url: https://github.com/packit/packit
...
jobs:
- job: pull_from_upstream
trigger: release
Expand Down

0 comments on commit bd8ef21

Please sign in to comment.