Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Delta Between Two Patch Sets: update-copyright/README.md

Issue 29459580: Issue 5250 - Add copyright update script (Closed) Base URL: https://hg.adblockplus.org/codingtools
Left Patch Set: Addressed more comments Created July 3, 2017, 3:31 p.m.
Right Patch Set: Fix indentation and default args Created July 17, 2017, 1:22 p.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
Left: Side by side diff | Download
Right: Side by side diff | Download
« no previous file with change/comment | « .hgignore ('k') | update-copyright/tests/data/hg_page.html » ('j') | no next file with change/comment »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
1 # update-copyright 1 # update-copyright
2 2
3 A script that accesses each repo listed on a Mercurial index, and updates the co pyrights on each page to the current year. 3 This script will attempt to update the eyeo copyright information on each
4 page of each repo listed on a Mercurial index page.
5 By default, running the script will scrape [https://hg.adblockplus.org/](https:/ /hg.adblockplus.org/),
6 and then for each repo, it will:
7 * make a local copy of the repo
8 * update the copyright information on each file to the current year
9 * attempt to push the updates to `ssh://hg@hg.adblockplus.org/`
4 10
5 ## Usage 11 If a user doesn't have permission to push to a repo, the script will make a
12 local `repo-name.patch` file to submit later.
6 13
7 Must specify which Mercurial URL site to scrape: 14 You are free to use this for other projects but please keep in mind that we
8 $ python3 update_copyright.py -u https://hg.adblockplus.org/ 15 make no stability guarantees whatsoever and might change functionality any
16 time.
9 17
10 May also specify which remote repo to push to: 18 ## How to use
11 $ python3 update_copyright.py -u https://hg.adblockplus.org/ -p ssh://hg@hg. adblockplus.org/ 19
20 To update the copyright on all the repos indexed at [https://hg.adblockplus.org/ ](https://hg.adblockplus.org/),
21 simply run the script, e.g.:
23 ./update_copyright.py
25 To run the script elsewhere, you must specify the URL for a Mercurial index
26 site to scrape, and the location of the base URL to push to, e.g.:
28 ./update_copyright.py -u https://hg.example.com/ -p ssh://user@hg.example.co m/
12 29
13 ## Testing 30 ## Testing
14 31
15 The tests can be run via [Tox](http://tox.readthedocs.org/) 32 Testing can be run via [tox](http://tox.readthedocs.org/).

Powered by Google App Engine
This is Rietveld