I think missing easy to use documentation is the most missing part of
current rpmautospec package. Manual page does not exist, readme is in
wrong package.
I have proposed to be able to include extra section just for changelog.
I do not remember which exactly way was merged instead, there should be
something use-able. But is not easy to find. Currently just first line
is used as changelog entry. It might be skipped with special tag in
commit, but that is nowhere to be found in documentation present with
the package.
I think simple tags could be used to mark noteworthy changes only for
releases. I think autospec is great, as it especially makes longer term
pull requests easy to merge. Avoiding stupid conflict with changelog
bumps. But I think there is still a lot to improve in usability part.
For many packages without significant function changes it is just fine.
Significant changes should be mentioned in updates or linked bugs,
rather than commit messages. But problem is rawhide automatic updates
contains just changelog and not really anything useful. I find it not
easy to fill this part.
If the project contains changelog, I would recommend it as part of the
package %doc files. It takes extra work to maintain one however. I would
find it nice to generate nice looking update messages from commit, but
current implementation is not sufficient IMO.
Nice looking references to upstream issues or release notes would be
nice too.
On 09. 04. 24 10:04, Remi Collet wrote:
Le 07/04/2024 à 17:15, Zbigniew Jędrzejewski-Szmek a écrit :
Thus, the proposal:
- new packages MUST use rpmautospec
- packagers SHOULD convert their packages
- provenpackagers MAY convert existing packages
(e.g. when they want to push some fix or separately from other
work)
- people submitting pull requests against src.fp.o MAY also
include a conversion in the pull request and packagers SHOULD
merge it.
Big -1 to all
git log IS NOT a package changelog
Read https://keepachangelog.com/en/1.1.0/
Remi
--
Petr Menšík
Software Engineer, RHEL
Red Hat, http://www.redhat.com/
PGP: DFCF908DB7C87E8E529925BC4931CA5B6C9FC5CB
--
_______________________________________________
devel mailing list -- devel@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to devel-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/devel@xxxxxxxxxxxxxxxxxxxxxxx
Do not reply to spam, report it: https://pagure.io/fedora-infrastructure/new_issue
