OffTopic: DependencyUpdater

eyeo-depup/README.md

 # Easy dependency updating
-
-
 
 ## Introduction
 
 This program is meant to ease the process of gathering information /
 preparing an issue on issues.adblockplus.org, in order to update a given

[kzar, 2017/11/27 15:03:32]

Maybe remove "on issues.adblockplus.org"?

 dependency.
 
 You can run this program to get a list of potentially included changes

[kzar, 2017/11/27 15:03:31]

Maybe reword this to "You can run this program to get a list of included
commits, view a unified diff of those changes and to generate a template issue
for our issue tracker. After you have filed the issue (and have a issue number)
you can use this program to commit the dependency update itself ready for code
review."

 (represented by their commit messages). You can create a unified diff of all
 potentially included changes or you can create an issue body, which is supposed
 to be filed on https://issues.adblockplus.org. After filing an issue and hence
 having a corresponding issue number, you can commit the necessary changes in
 order to actually perform a dependency update.
 
 Since there won't be any way to bridge submodules / subrepositories between

[kzar, 2017/11/27 15:03:30]

Maybe add more context here? "In order to provide commit hashes for both
Mercurial and Git..."

 Git and Mercurial any time soon, we will stay dependent on a manual approach
 for mirroring these ourselves.
 
 ## Requirements
 
  - [Python 2.7](https://www.python.org/download/releases/2.7/)
  - [Git](https://git-scm.com/)
  - [Mercurial](https://www.mercurial-scm.org/)
 
 _(Please note, as soon as https://hg.adblockplus.org/buildtools/file/tip/ensure_dependencies.py
@@ skipping 106 matching lines @@
 --- a/.gitignore
 +++ b/.gitignore
 @@ -1,3 +1,6 @@
  *.pyc
  *.pyo
  /.tox
 +/.cache
 +.coverage
 
 ...
 ...

[kzar, 2017/11/27 15:03:30]

Nit: Duplicate ellipses.

 ```
 
 ### Commit all necessary changes (along with file updates done by ensure_dependencies.py) to perform a dependency update
 **Note**: You must have already created an issue and know the corresponding
 issue number for this
 ```
 $ eyeo-depup commit buildtools 5698
 ```
 
 Result:
@@ skipping 25 matching lines @@
     diff        Create a unified diff of all changes
     issue       Render an issue body
     changes     Generate a list of commits between two revisions
     commit      Update and commit a dependency change
 
 ```
 
 ### diff
 
 ```
-usage: eyeo-depup diff [-h] [-r NEW_REVISION] [-m LOCAL_MIRROR] [-f FILENAME] [-s]
-                  [-l] [-n UNIFIED_LINES]
-                  dependency
+usage: eyeo-depup diff [-h] [-r NEW_REVISION] [-m LOCAL_MIRROR] [-f FILENAME]
+                       [-s] [-l] [-n UNIFIED_LINES]
+                       dependency
 
 Invoke the current repository's VCS to generate a diff, containing all changes
 made between two revisions.
 
 optional arguments:
   -h, --help            show this help message and exit
   -n UNIFIED_LINES, --n-context-lines UNIFIED_LINES
                         Number of unified context lines to be added to the
                         diff. Defaults to 16 (Used only with -d/--diff).
 
@@ skipping 15 matching lines @@
                         Search https://issues.adblockplus.org for integration
                         notes associated with the included issue IDs. The
                         results are written to STDERR. CAUTION: This is a very
                         network heavy operation.
 
 ```
 
 ### changes
 
 ```
-usage: eyeo-depup changes [-h] [-r NEW_REVISION] [-m LOCAL_MIRROR] [-f FILENAME]
-                     [-s] [-l]
-                     dependency
+usage: eyeo-depup changes [-h] [-r NEW_REVISION] [-m LOCAL_MIRROR]
+                          [-f FILENAME] [-s] [-l]
+                          dependency
 
 Generate a list of commit hashes and commit messages between the dependency's
 current revision and a given new revision.
 
 optional arguments:
   -h, --help            show this help message and exit
 
   dependency            The dependency to be updated, as specified in the
                         dependencies file.
   -r NEW_REVISION, --revision NEW_REVISION
@@ skipping 12 matching lines @@
                         Search https://issues.adblockplus.org for integration
                         notes associated with the included issue IDs. The
                         results are written to STDERR. CAUTION: This is a very
                         network heavy operation.
 
 ```
 
 ### issue
 
 ```
-usage: eyeo-depup issue [-h] [-r NEW_REVISION] [-m LOCAL_MIRROR] [-f FILENAME] [-s]
-                   [-l] [-t TMPL_PATH]
-                   dependency
+usage: eyeo-depup issue [-h] [-r NEW_REVISION] [-m LOCAL_MIRROR] [-f FILENAME]
+                        [-s] [-l] [-t TMPL_PATH]
+                        dependency
 
 Render an issue subject and an issue body, according to the given template.
 
 optional arguments:
   -h, --help            show this help message and exit
   -t TMPL_PATH, --template TMPL_PATH
                         The template to use. Defaults to the provided
-                        default.trac (Used only with -i/--issue).
+                        default.trac.
 
   dependency            The dependency to be updated, as specified in the
                         dependencies file.
   -r NEW_REVISION, --revision NEW_REVISION
                         The revision to update to. Defaults to the remote
                         master bookmark/branch. Must be accessible by the
                         dependency's vcs.
   -m LOCAL_MIRROR, --mirrored-repository LOCAL_MIRROR
                         Path to the local copy of a mirrored repository. Used
                         to fetch the corresponding hash. If not given, the
                         source parsed from the dependencies file is used.
   -f FILENAME, --filename FILENAME
                         When specified, write the subcommand's output to the
                         given file, rather than to STDOUT.
   -s, --skip-mirror     Do not use any mirror.
   -l, --lookup-integration-notes
                         Search https://issues.adblockplus.org for integration
                         notes associated with the included issue IDs. The
                         results are written to STDERR. CAUTION: This is a very
                         network heavy operation.
 
 ```
 
 ### commit
 
 ```
 usage: eyeo-depup commit [-h] [-r NEW_REVISION] [-m LOCAL_MIRROR]
-                    dependency issue_number
+                         dependency issue_number
 
 Rewrite and commit a dependency file to the new revision. WARNING: This
 actually changes your repository's history, use with care!
 
 positional arguments:
   issue_number          The issue number, filed on
                         https://issues.adblockplus.org
 
 optional arguments:
   -h, --help            show this help message and exit
@@ skipping 69 matching lines @@
 || {{ hg_hash }} || {{ git_hash }} ||
 
 === Integration Notes ===
 
 CHANGE ME!
 
 === Hints for testers ===
 
 CHANGE ME!
 ```