Noissue - Improve dependency management documentation

Noissue - Improve
dependency management documentation

[a.giammarchi, 2018-02-07 11:50:30]

I am working on a ticket that requires changes across multiple repositories such
adblockpluschrome and adblockplusui.

If I change adblockplusui and I try to build via adblockpluschrome, build tools
will try to switch to versions specified inside dependencies file, making the
build either fail or useless.

There are few possible workarounds for this issue but looking inside the build
script I've noticed this nice and clean way to skip those checks and obtain the
build based on current branches.

I hope the added documentation makes sense and it will help eventually future
new comers too.

[Thomas Greiner, 2018-02-07 13:39:33]

Note that any contributions to other modules also require approval from the
module owner or one of its peers (see adblockplus.org/modules and
https://adblockplus.org/en/module-ownership). Therefore I added Dave and
Sebastian to CC since this affects the Platform module.

[a.giammarchi, 2018-02-07 14:11:47]

On 2018/02/07 13:39:33, Thomas Greiner wrote:
> Note that any contributions to other modules also require approval from the
> module owner or one of its peers (see adblockplus.org/modules and
> https://adblockplus.org/en/module-ownership). Therefore I added Dave and
> Sebastian to CC since this affects the Platform module.

Thanks Thomas, I wasn't sure who to CC indeed and I wish trac could suggest out
of the box team members.

Apologies for omitting the right people in the first place.

[kzar, 2018-02-12 14:06:53]

Nice idea to add some more information here, I think it would be useful for
someone new getting started.

I suggest a commit name (review title) of something like "Noissue - Improve
dependency management documentation".

https://codereview.adblockplus.org/29691573/diff/29691574/README.md
File README.md (right):

https://codereview.adblockplus.org/29691573/diff/29691574/README.md#newcode70
README.md:70: #### Skip dependencies check
Ditch the header IMO.

https://codereview.adblockplus.org/29691573/diff/29691574/README.md#newcode72
README.md:72: If you are modifying `adblockpluscore` or `adblockplusui` and you
would like
How about this?

The build script calls the ensure_dependencies script automatically to manage
the dependencies (see _dependencies_ file). Dependencies with local
modifications won't be updated. Otherwise during development specifying a
feature-branch's name for a dependency's revision is sometimes useful.
Alternatively dependency management can be disabled completely by setting the
_SKIP_DEPENDENCY_UPDATES_ environment variable, for example:

    SKIP_DEPENDENCY_UPDATES=1 ./build.py devenv -t chrome

[a.giammarchi, 2018-02-12 15:02:23]

https://codereview.adblockplus.org/29691573/diff/29691574/README.md
File README.md (right):

https://codereview.adblockplus.org/29691573/diff/29691574/README.md#newcode70
README.md:70: #### Skip dependencies check
On 2018/02/12 14:06:53, kzar wrote:
> Ditch the header IMO.

Done.

https://codereview.adblockplus.org/29691573/diff/29691574/README.md#newcode72
README.md:72: If you are modifying `adblockpluscore` or `adblockplusui` and you
would like
On 2018/02/12 14:06:53, kzar wrote:
> How about this?
> 
> The build script calls the ensure_dependencies script automatically to manage
> the dependencies (see _dependencies_ file). Dependencies with local
> modifications won't be updated. Otherwise during development specifying a
> feature-branch's name for a dependency's revision is sometimes useful.
> Alternatively dependency management can be disabled completely by setting the
> _SKIP_DEPENDENCY_UPDATES_ environment variable, for example:
> 
>     SKIP_DEPENDENCY_UPDATES=1 ./build.py devenv -t chrome

Done.

[kzar, 2018-02-12 15:30:25]

LGTM (If you don't have push rights you can email the patch to me
dave@adblockplus.org.)