801230 - Add a cfx sdocs option to override the version

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: Documentation, defect)

Description

[Will Bamberg [:wbamberg]]

cfx has some cleverness inside it to work out the version from the Git tag used for that SDK release. This means most code that needs to be version-aware doesn't have to be updated manually when the version changes.

Unfortunately this isn't much help to cfx sdocs, because I need to generate the web docs for AMO before we create the final tag for that release (that is, I need to create it while the version is still "1.10b1" or "1.8rc2" or something).

Until now I've updated the version completely manually. But in bug 779590 I'll change the way the AMO docs get built and delivered, so as to support "obsoleting" old versions of the docs, and I'll need a way to at least semi-automate setting correct versions.

This bug is to add a --override-version option to cfx sdocs, which will enable me (or a script that I write) to correct the version baked into the docs header.

Comment 1

[Will Bamberg [:wbamberg]]

Attachment: add --override-version to cfx sdocs

Comment 2

[Jeff Griffiths (:canuckistani) (:⚡︎)]

Comment on attachment 671026 [details]
add --override-version to cfx sdocs

wfm: ./bin/cfx sdocs --override-version=1.42.5

Comment 3

[Jeff Griffiths (:canuckistani) (:⚡︎)]

Aside: how do you generate deprecated docs?

Comment 4

[[github robot]]

Commit pushed to master at https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/56c8b5970d7554f65a1e359bad97f677ba63a4f8
Merge pull request #604 from wbamberg/779590

Fix for Bug 801230 - Add a cfx sdocs option to override the version

Comment 5

[[github robot]]

Commits pushed to stabilization at https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/d86320341215f122a27c9380b7e0170fb415c0f4
Reapply fix for 'Bug 801230 - Add a cfx sdocs option to override the version' to stabilization

https://github.com/mozilla/addon-sdk/commit/d0c19c202f73a44cf0cad96e19ca272d6538fffd
Merge pull request #609 from wbamberg/801230-stabilization

Reapply fix for 'Bug 801230 - Add a cfx sdocs option to override the ver...