WordPress.org

Make WordPress Core

Opened 11 months ago

Last modified 4 weeks ago

#51126 reviewing enhancement

Document the update offer parameter for auto updates

Reported by: johnbillion Owned by: desrosj
Milestone: 5.9 Priority: normal
Severity: normal Version:
Component: Upgrade/Install Keywords: has-patch
Focuses: docs Cc:

Description

The "update offer" for auto updates gets retrieved from the updates API, passed between methods, stored in transients, and sent through filters. Its shape should be documented in all these places.

Attachments (3)

51126.diff (1.8 KB) - added by johnbillion 11 months ago.
51126.1.diff (2.1 KB) - added by audrasjb 3 months ago.
Patch refresh
51126.2.diff (11.3 KB) - added by audrasjb 5 weeks ago.
Added update offer documentation in other functions/hooks

Download all attachments as: .zip

Change History (14)

This ticket was mentioned in Slack in #core-auto-updates by pbiron. View the logs.


11 months ago

@johnbillion
11 months ago

#2 @johnbillion
11 months ago

  • Keywords has-patch added; needs-patch removed

51126.diff is a first pass at this. Needs more work.

#3 @johnbillion
11 months ago

  • Type changed from defect (bug) to enhancement

This ticket was mentioned in Slack in #core-auto-updates by audrasjb. View the logs.


11 months ago

@audrasjb
3 months ago

Patch refresh

#5 @audrasjb
3 months ago

  • Milestone changed from Awaiting Review to 5.8

51126.1.diff refreshes the previous patch and adds descriptions for the $packages URLs.
Moving for 5.8 consideration.

#6 @desrosj
2 months ago

  • Keywords needs-refresh added

I haven't gotten to review this one, but because it's a documentation only change, it can remain in the milestone and be made after the feature freeze date (which is today).

@audrasjb would you be able to refresh the patch to add the description to the other filters and actions receiving the offerings from the API?

#7 @desrosj
7 weeks ago

This one still needs a refresh. It is beta 1 day today, but this only affects inline documentation, so it can remain for the time being.

This ticket was mentioned in Slack in #core-auto-updates by audrasjb. View the logs.


7 weeks ago

@audrasjb
5 weeks ago

Added update offer documentation in other functions/hooks

#9 @audrasjb
5 weeks ago

  • Keywords needs-refresh removed

Hey @desrosj I refreshed the patch with proper docs for the update offer in other functions/hooks.

#10 @desrosj
5 weeks ago

  • Owner changed from johnbillion to desrosj
  • Status changed from assigned to reviewing

#11 @desrosj
4 weeks ago

  • Milestone changed from 5.8 to 5.9

Unfortunately, there are too many other tickets that have been identified that must be fixed for 5.8, so I'm going to punt this one as I won't have the time to thoroughly review. If another committer is able to review and get this one committed prior to RC on Tuesday (29 June), feel free to reassign and shepherd it in.

Note: See TracTickets for help on using tickets.