Skip to content

Document 'copy_upstream_release_description' config option #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
softwarefactory-project-zuul merged 2 commits into from
Nov 5, 2020
Merged

Document 'copy_upstream_release_description' config option #182

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5b8f64
Document 'copy_upstream_release_description' config option
lbarcziova Nov 4, 2020
ebd5d28
Add an example
lbarcziova Nov 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions content/docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,26 @@ notifications:

You can disable the commenting by setting `successful_build` to `false`.

#### copy_upstream_release_description
(*bool*) When doing a new update in Fedora dist-git, the Github upstream release description
is copied to the spec-file changelog when set to `true`. By default (`false`),
all messages of new commits are copied.

@TomasTomecek TomasTomecek Nov 4, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if it makes sense to provide an example here.

@lbarcziova lbarcziova Nov 5, 2020

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated it, WDYT?

e.g.
- `copy_upstream_release_description = True`:
```
%changelog
* Thu Oct 15 2020 Packit Service <user-cont-team+packit-service@redhat.com> - 0.18.0-1
Packit got new archive_root_dir_template config option to get custom archive root dir.
You can find more info in the documentation.
```
- `copy_upstream_release_description = False` (default):
```
%changelog
* Thu Oct 15 2020 Packit Service <user-cont-team+packit-service@redhat.com> - 0.18.0-1
- Use inner archive directory in %setup macro
- Use archive_root_dir_template
```

### Minimal sample config

This is a sample config which is meant for [packit](https://github.com/packit/packit) itself.
Expand Down