-
Notifications
You must be signed in to change notification settings - Fork 4
Add specific upgrade instructions (if any) to PR body #20
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.
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
base: main
Are you sure you want to change the base?
Conversation
Did I discuss something about it ? 😅 Anyway sounds like an improvement to push such kind of info and formatting to more packages :) |
Yes, with m606, about some process to be done before updating jsoncrack. |
That's exactly the point, for package maintainers, but also for others - people helping package maintainers, or people that may come as new package maintainer of an abandoned package.
Sure, there can be various use cases depending on apps (and maintainers).
Regarding the wiki use in itself, I indeed followed your suggestion @DeMiro5001, which was both relevant and quick to setup, although I wonder whether that would not create additional complexity in the long run to have yet another place with info on a package.
And that info for those files could be automatically used in some other places of YNH documentation infra. However for now, I quote this point from @alexAubin which I tend to agree with:
So before a more general solution is thought of, I used the various suggestions received to set up with this PR PACKAGE_UPDATE.md at package's root, linking towards detailed instructions in a package repo's wiki page. |
Mini-wiki for lychee, so I keep track of what I have done and what I am planning to do in a human readable format : |
Note that for TO-DO list, there could be alternatives in Github:
Which would somehow makes changelog rather obvious if PR are properly named. Although it would make repos even more complex on a broader scale! |
Upgrade to v2025.02.05 and fix github workflow on_upstream adds PACKAGE_UPDATE.md info (related to YunoHost/apps_tools#20)
yesyesyesyes Let me just create a documentation PR for this before merging. We don't want this feature to be lost in code. |
Upstream upgrade for some apps needs more than just passing CI to get merged (e.g. jsoncrack_ynh)
This PR aims at implementing what was discussed earlier with @alexAubin, @orhtej2, miro5001 and @lapineige, i.e. short instructions's reminder in the upgrade PR created by the autoupdate script. Those are taken located at the app's root, in the file
PACKAGE_UPDATE.md
(@alexAubin, we had talked of calling itMAINTENANCE.md
, but after a second though it seems to me that since this is meant to be displayed exclusively in autoupdate PR, it may be more fair to have a more specific filename). Here is an example: https://github.com/YunoHost-Apps/jsoncrack_ynh/blob/testing/PACKAGE_UPDATE.mdIt will come together with a link to detailed instructions located in Github wiki (to avoid adding translation work in README.md for info which is only relevant to package maintainers). It could be later added to YNH doc if several apps share similar detailed instructions (e.g. maybe all apps using NPM, etc.). Here is an example: https://github.com/YunoHost-Apps/jsoncrack_ynh/wiki/How-to-apply-upstream-upgrades-to-this-package
PR is short & simple but wasn't tested.