Mercurial > september
annotate README.md @ 5:9c6605b1619b draft default tip
Make directories absolute and expand tilde-paths.
| author | Ludovic Chabant <ludovic@chabant.com> |
|---|---|
| date | Tue, 12 May 2015 23:55:27 -0700 |
| parents | 455043eb436a |
| children |
| rev | line source |
|---|---|
| 2 | 1 |
| 2 # SEPTEMBER | |
| 3 | |
| 4 September is a program that takes a source controlled project, goes back to | |
| 5 specific points in that project's timeline, and does something. | |
| 6 | |
| 7 This is typically useful for generating documentation for each released version | |
| 8 of a project, but it can do other stuff like report on how the code evolved over | |
| 9 time in terms of amount or complexity. | |
| 10 | |
| 11 | |
| 12 ## Usage | |
| 13 | |
| 14 You simply run it by pointing at your repo: | |
| 15 | |
| 16 python september.py /path/to/repo --command "foo bar" | |
| 17 | |
| 18 By default, this will clone your repository into a temporary directory (which | |
| 19 you can override with the `--tmp-dir` argument), update back to every tag, and | |
| 20 run `foo bar` each time at the root of the clone. | |
| 21 | |
|
3
455043eb436a
More info in the README.
Ludovic Chabant <ludovic@chabant.com>
parents:
2
diff
changeset
|
22 If you already ran September previously, however, it will only run the command |
|
455043eb436a
More info in the README.
Ludovic Chabant <ludovic@chabant.com>
parents:
2
diff
changeset
|
23 on any new/changed tag. You can see what September remembers by using the |
|
455043eb436a
More info in the README.
Ludovic Chabant <ludovic@chabant.com>
parents:
2
diff
changeset
|
24 `--status` argument. |
|
455043eb436a
More info in the README.
Ludovic Chabant <ludovic@chabant.com>
parents:
2
diff
changeset
|
25 |
| 2 | 26 September will guess what kind of repository you're giving it, and do the |
| 27 appropriate things to clone and update it. Right now Git and Mercurial are | |
| 28 supported. | |
| 29 | |
| 30 | |
| 31 ## Configuration file | |
| 32 | |
| 33 You can pass a configuration file to September with the `--config` argument. If | |
| 34 you have a `.september.cfg` file at the root of your repository, it will pick it | |
| 35 up automatically otherwise. | |
| 36 | |
| 37 The configuration file must specify settings in a `september` section: | |
| 38 | |
| 39 [september] | |
| 40 command = echo "Processing tag %(tag)s..." | |
| 41 use_shell = 1 | |
| 42 | |
| 43 Supported configuration settings include: | |
| 44 | |
| 45 * `command`: The command to run. Use `%(tag)s` to insert the name of current tag | |
| 46 in the command. | |
| 47 * `use_shell`: Whether the command should be passed to a shell (_e.g._ if using | |
| 48 shell commands like `ls` or `echo`, or using pipes or redirection). | |
| 49 * `first_tag`: Don't update to tags older than the tag specified as the first | |
| 50 tag. | |
| 51 * `tag_pattern`: A regular expression that defines which tags to consider. Any | |
| 52 tag that _doesn't_ match the pattern will be ignored. | |
| 53 |