Merge lp://staging/~abreu-alexandre/unity-js-scopes/doc into lp://staging/unity-js-scopes

FAILED: Continuous integration, rev:90
http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/15/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-amd64-ci/15/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/15/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-i386-ci/15/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/15/rebuild

FAILED: Continuous integration, rev:91
http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/16/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-amd64-ci/16/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/16/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-i386-ci/16/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/16/rebuild

FAILED: Continuous integration, rev:92
http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/17/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-amd64-ci/17/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/17/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-i386-ci/17/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/17/rebuild

Sorry if I'm being captain obvious here, but the build is failing with:

Found 7 license problems:
doc/docbuild/assets/js/yui-prettify.js UNKNOWN {
doc/docbuild/assets/js/api-list.js UNKNOWN *No copyright*
doc/docbuild/assets/js/apidocs.js UNKNOWN *No copyright*
doc/docbuild/assets/js/api-search.js UNKNOWN *No copyright*
doc/docbuild/assets/js/api-filter.js UNKNOWN *No copyright*
doc/docbuild/assets/vendor/prettify/prettify-min.js UNKNOWN *No copyright*
doc/docbuild/api.js UNKNOWN *No copyright*

> Sorry if I'm being captain obvious here, but the build is failing with:
>
> Found 7 license problems:
> doc/docbuild/assets/js/yui-prettify.js UNKNOWN {
> doc/docbuild/assets/js/api-list.js UNKNOWN *No copyright*
> doc/docbuild/assets/js/apidocs.js UNKNOWN *No copyright*
> doc/docbuild/assets/js/api-search.js UNKNOWN *No copyright*
> doc/docbuild/assets/js/api-filter.js UNKNOWN *No copyright*
> doc/docbuild/assets/vendor/prettify/prettify-min.js UNKNOWN *No copyright*
> doc/docbuild/api.js UNKNOWN *No copyright*

Sorry, just looked at this again. When did this become a build requirement? Do you know if we can somehow bypass these checks?

Ok I've asked CI to remove this licence check hook from our builds.

So firstly, when I tried to build, you're generate-doc.py script returned:

Traceback (most recent call last):
  File "/home/marcustomlinson/Projects/work/unity-js-scopes/trunk/doc/generate-doc.py", line 39, in <module>
    yui_install = subprocess.check_output(['which', 'yuidoc'])
  File "/usr/lib/python3.4/subprocess.py", line 620, in check_output
    raise CalledProcessError(retcode, process.args, output=output)
subprocess.CalledProcessError: Command '['which', 'yuidoc']' returned non-zero exit status 1

So seems the line "yui_install = subprocess.check_output(['which', 'yuidoc'])" doesn't quite do what you wanted.

Then I see a bit further down your error message tells you to install npm, nodejs-legacy, and yuidocjs manually. How is this going to be possible in CI?

I would strongly recommend we avoid redundantly installing npm and node on the system when we have it embedded into our own stuff. The unity-js-scopes-tool has npm smarts embedded into it. I think we can come up with a good way of pulling and running yuidocjs using just the tool.

FYI, don't know if you pick this up, but you can run a .js file by calling: "unity-js-scopes-tool program.js". Its a hack I had to do in order to get npm builds working as they needed access to the node executable.

The doc generation target could be removed from the CI builds, and left
only as a manual step when releasing a package for publication on
developer.ubuntu.com.

On Thu, Oct 22, 2015 at 9:31 AM, Marcus Tomlinson <
<email address hidden>> wrote:

> Review: Needs Fixing
>
> Ok I've asked CI to remove this licence check hook from our builds.
>
> So firstly, when I tried to build, you're generate-doc.py script returned:
>
> Traceback (most recent call last):
> File
> "/home/marcustomlinson/Projects/work/unity-js-scopes/trunk/doc/generate-doc.py",
> line 39, in <module>
> yui_install = subprocess.check_output(['which', 'yuidoc'])
> File "/usr/lib/python3.4/subprocess.py", line 620, in check_output
> raise CalledProcessError(retcode, process.args, output=output)
> subprocess.CalledProcessError: Command '['which', 'yuidoc']' returned
> non-zero exit status 1
>
> So seems the line "yui_install = subprocess.check_output(['which',
> 'yuidoc'])" doesn't quite do what you wanted.
>
> Then I see a bit further down your error message tells you to install npm,
> nodejs-legacy, and yuidocjs manually. How is this going to be possible in
> CI?
>
> I would strongly recommend we avoid redundantly installing npm and node on
> the system when we have it embedded into our own stuff. The
> unity-js-scopes-tool has npm smarts embedded into it. I think we can come
> up with a good way of pulling and running yuidocjs using just the tool.
>
> FYI, don't know if you pick this up, but you can run a .js file by
> calling: "unity-js-scopes-tool program.js". Its a hack I had to do in order
> to get npm builds working as they needed access to the node executable.
> --
>
> https://code.launchpad.net/~abreu-alexandre/unity-js-scopes/doc/+merge/274488
> Your team WebApps is subscribed to branch lp:unity-js-scopes.
>

> The doc generation target could be removed from the CI builds, and left
> only as a manual step when releasing a package for publication on
> developer.ubuntu.com.

I think it is a requirement that our project builds a *-doc package for d.u.c to collect. Alex will have to confirm though.

The docs are statically (manually built) and then committed in the source package. I did it this way so that we dont have to be bothered w/ all those node deps obviously.

So it is an offline process basically,

And the -doc package is there, ... just pulls the statically built docs,

K, I'm approving this MP on condition that Jenkins also approves the remaining copyright issues.

FAILED: Continuous integration, rev:93
http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/22/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-amd64-ci/22/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/22/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-i386-ci/22/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/22/rebuild

> FAILED: Continuous integration, rev:93
> http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/22/
> Executed test runs:
> FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-
> amd64-ci/22/console
> FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-
> ci/22/console
> FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-
> wily-i386-ci/22/console
>
> Click here to trigger a rebuild:
> http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/22/rebuild

Doh...

Possibly the easiest way to fix this would be to put those files into a directory called 3rd_party, then they would be automatically ignored by the check.

Oops changed my review status by mistake, setting back to Approved.

Ah, sorry man, gotta set this back to "Needs Fixing". Something you've changed in this branch has caused our examples to error out with this now:

                    return new scopes.lib.search_query(
                           ^

Error: expected an exported object
    at Error (native)
    at scopes.self.initialize.search (/home/marcustomlinson/build-untitled1-Desktop-Default/src/untitled1.marcustomlinson_untitled1.js:55:28)

I reverted this branch's changes from my tool-setup branch, and things start working again.

updated for the searchmetadata bit

Great thanks! Now just for those copyright errors.

FAILED: Continuous integration, rev:94
http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/27/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-amd64-ci/27/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/27/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-i386-ci/27/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/27/rebuild

Damn, there are SearchMetadata and SearchMetaData mismatches now.

Could you rather rename "SearchMetaData" to "SearchMetadata" to match the original.

One main issue I'm seeing with these docs now is the mismatch in class names from docs to actual. I.e. The docs refer to class names in "ClassName" format, whereas the actual API has class names formatted as "class_name".

> Could you rather rename "SearchMetaData" to "SearchMetadata" to match the
> original.

agree, done

> One main issue I'm seeing with these docs now is the mismatch in class names
> from docs to actual. I.e. The docs refer to class names in "ClassName" format,
> whereas the actual API has class names formatted as "class_name".

yes, agree too, I did push this off as a TODO in my list, ... mind if I make it
part of a more global MR tomorrow ?