Closed
Bug 1108076
Opened 9 years ago
Closed 9 years ago
Replace CVS and bzr-based docs build system with git-based system
Categories
(Bugzilla :: bugzilla.org, defect)
Tracking
()
RESOLVED
FIXED
People
(Reporter: gerv, Assigned: gerv)
References
Details
Attachments
(1 file)
6.90 KB,
patch
|
justdave
:
review+
|
Details | Diff | Splinter Review |
We can no longer build the trunk API docs for the website from bzr because, due to my VCS misadventures, we are no longer updating trunk bzr so the api docs are "frozen" at what they were when that happened. So, we need to do a git-based build system for at least the trunk API docs. And, if we do that, we might as well convert everything over to build from git (unless some wrinkle comes up). Gerv
Assignee | ||
Comment 1•9 years ago
|
||
So here's the plan: * Check in static copies of the docs for all branches which are no longer supported. * Change the build system to pull from git (only) and only build supported branches. * The system will continue to build both XML and POD docs for 4.0, 4.2 and 4.4, and just POD for 5.0 and trunk. * We pull docs from the stable development branch (e.g. "5.0") not the stable non-development branch (e.g. "bugzilla-5.0-stable"); this allows us to deploy docs fixes between releases. Gerv
Assignee | ||
Comment 2•9 years ago
|
||
Question: it's currently doing this the naive way, with one clone per branch. However, one could easily imagine a system which used a single clone and just did a git checkout <branchname> for each branch before building it. That might be faster. If anyone has a strong preference for one over the other, do say. Gerv
Assignee | ||
Comment 3•9 years ago
|
||
This seems to work. The only caveat is that I haven't managed to set up an environment which can build the 4.0 and 4.2 XML docs. But I haven't significantly changed the code which does that, so I hope it'll still work. Gerv
Assignee | ||
Comment 4•9 years ago
|
||
This change would also require checking in static copies of all the docs builds from before 4.0. Fortunately, justdave has supplied me with built copies from the current webserver machine, so I can do that. Gerv
Assignee | ||
Comment 6•9 years ago
|
||
Recently on IRC: 15:46:32 - gerv: Did you finish that review? :-) 18:11:52 - justdave: patch doesn't apply cleanly 18:11:58 - justdave: etc/docs-versions fails 18:22:27 - gerv: justdave: because I backed out the building of trunk since. it's an easy fix 18:22:38 - gerv: Do you have any other review comments? 18:23:57 - justdave: I got it working on landfill finally. All looks good, didn't make it back to the bug yet 18:24:05 - gerv: Great, thanks :-) 18:24:19 - gerv: If you can post an r+, I can fix the conflict, check in, 18:24:22 - gerv: and then we can see if it works :-) 18:29:26 - justdave: just woke up, working on becoming awake right now, should get the bug updated in an hour or so 18:29:37 - gerv: Thanks :-))
Flags: needinfo?(justdave)
Comment 7•9 years ago
|
||
Comment on attachment 8534356 [details] [diff] [review] Patch v.1 Boy, that was a long hour. Sorry about that. This looks good, let's go ahead and get it in. Ping me on IRC before committing so I can be on hand to make sure it deploys correctly on the webserver.
Flags: needinfo?(justdave)
Attachment #8534356 -
Flags: review?(dkl) → review+
Assignee | ||
Comment 8•9 years ago
|
||
Checking in etc/docs-versions; /www/bugzilla-org/etc/docs-versions,v <-- docs-versions new revision: 1.14; previous revision: 1.13 done Checking in bin/build-docs.pl; /www/bugzilla-org/bin/build-docs.pl,v <-- build-docs.pl new revision: 1.14; previous revision: 1.13 done Gerv
Assignee | ||
Comment 9•9 years ago
|
||
I've checked in static copies of all docs up to and including 3.6, because the system no longer builds them. <many other files> ... Checking in src/docs/3.6/en/xml/troubleshooting.xml; /www/bugzilla-org/src/docs/3.6/en/xml/troubleshooting.xml,v <-- troubleshooting.xml initial revision: 1.1 done RCS file: /www/bugzilla-org/src/docs/3.6/en/xml/using.xml,v done Checking in src/docs/3.6/en/xml/using.xml; /www/bugzilla-org/src/docs/3.6/en/xml/using.xml,v <-- using.xml initial revision: 1.1 done Gerv
Comment 10•9 years ago
|
||
This is done. Bug 1112384 filed for the regression.
Status: ASSIGNED → RESOLVED
Closed: 9 years ago
Resolution: --- → FIXED
You need to log in
before you can comment on or make changes to this bug.
Description
•