1531491 - generic-worker: payload docs out-of-date

Status: RESOLVED FIXED

(Taskcluster :: Workers, enhancement)

Description

[Pete Moore [:pmoore][:pete]]

(In reply to Simon Sapin (:SimonSapin) from bug 1495732 comment 6)

It looks like this is not yet documented on https://docs.taskcluster.net/docs/reference/workers/generic-worker/docs/payload. What source is this page generated from?

Thanks for raising this! I think I see what may have happened (although still not entirely sure).

In PR #126 I switched the location where we publish the schema(s) from:

https://schemas.taskcluster.net/generic-worker/v1/payload.json

to:

https://schemas.taskcluster.net/generic-worker/v1/windows.json
https://schemas.taskcluster.net/generic-worker/v1/linux.json
https://schemas.taskcluster.net/generic-worker/v1/macos.json

Previously we were only publishing the windows payload schema, and I changed to publish schemas for all three platforms.

The markdown for that page is only published from the master branch and so the current live document is still looking for the payload.json file. I suspect when I published the updated schemas, I published the individual platform schemas with the new names {windows,linux,macos}.json, and so the payload.json is still the old windows schema.

I'm still not 100% sure so raising this bug while I troubleshoot the issue.

Comment 1

[Pete Moore [:pmoore][:pete]]

Hoping this will fix it...

Comment 2

[Pete Moore [:pmoore][:pete]]

I see references to "Raw Content" and "Base64 Content" in https://docs.taskcluster.net/docs/reference/workers/generic-worker/docs/payload so I think this was successful.