596092 - Get rid of the 'misc' root dir and create a 'bin/integration-scripts' dir

Status: RESOLVED FIXED

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

Description

[Atul Varma [:atul]]

The 'misc' directory at the root of the jetpack-sdk is confusing; I just entered it thinking that it might contain the code for the documentation browser, since that (and many other things) might ostensibly be in a root "misc" directory.

To avoid such confusion and ambiguity while keeping the root directory structure reasonably easy to understand and not-overwhelming for new users of the SDK, I recommend creating a new directory, 'bin/integration-scripts', and moving the single file in 'misc', a file called 'buildbot-run-cfx-helper', into it. We should also move bin/integration-check in there since it's an integration-related script too.

The purpose of anything in 'bin/integration-scripts' would then be to contain any scripts that are solely run during continuous integration testing.

Comment 1

[Atul Varma [:atul]]

Attachment: Pointer to Github pull request containing patch.

Comment 2

[Brian Warner [:warner :bwarner]]

I find it a tiny bit weird to have directories inside the directories that are on my PATH (as bin/ is after invoking "activate"). I also want to limit the number of commands that wind up on my PATH (i.e. I don't really want bin/integration-check or bin/quick-start to be there, competing with whatever more common commands I could get to by typing "i n <TAB>", etc). But I agree that having this weird "misc" directory up at the root is confusing, and I'd rather see a bin/misc than a top-level misc/ . So I'll go along with this change, and encourage moving bin/integration-check into bin/integration-scripts/ to remove it from my PATH (which would require some changes on the buildbot side, I believe).

Comment 3

[Brian Warner [:warner :bwarner]]

Comment on attachment 480775 [details]
Pointer to Github pull request containing patch.

patch looks ok to me. I think the releng/qa folks need to know about the move of integration-script though, they'll need to update a command so it matches.

neat redirection trick! we have a lot to figure out about maintaining a discussion both here on bugzilla and over on github. It'd be nice if we could add a button on the github side that would jump back here and push the "r+" button.

Comment 4

[Atul Varma [:atul]]

Thanks! Hmm, I could make a Jetpack for that github button idea!

Comment 5

[Atul Varma [:atul]]

Pushed:

Bug 596092 - Get rid of the 'misc' root dir and create a 'bin/integration-scripts' dir (r=warner)
Atul Varma
http://hg.mozilla.org/labs/jetpack-sdk/rev/06d702dab7eb

Comment 6

[Myk Melez [:myk] [@mykmelez]]

The Add-on SDK is no longer a Mozilla Labs experiment and has become a big enough project to warrant its own Bugzilla product, so the "Add-on SDK" product has been created for it, and I am moving its bugs to that product.

To filter bugmail related to this change, filter on the word "looptid".