about summary refs log tree commit diff stats
path: root/doc/howto-publish-a-release.md
blob: 6bd700471b094668df9e354777b04023b962c591 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
Prepare the "stable" branch
---------------------------
Before you can do anything else, you need to decide what should be included in
the new version.

**Bugfix releases** bump the third number of the version, e.g. 1.9.0 -> 1.9.1.
They may include bugfix commits that you `git cherry-pick`ed from the master
branch into the stable branch, or you can just do a fast-forward merge of
master into stable, if there were only bugfix commits since the last major
version.  You can also add minor new features that are very likely not causing
any bugs.  However, there should be absolutely **no** backward-incompatible
changes, like:

- renamed or removed settings, commands or python functions
- renamed, removed or reordered function arguments
- change in syntax of configuration files or in API of configuration scripts

New settings are okay, just make sure a sane default value is defined.

**Major releases** bump the second number of the version, e.g. 1.9.2 -> 1.10.0
and are necessary if you introduce any breaking changes, like the ones
mentioned in the list above.

Test everything
----------------
* [ ] `make test`
* [ ] `./ranger.py [--clean]`
* [ ] `ranger/ext/rifle.py`
* [ ] `make install`

Make a release commit
---------------------
* [ ] Update the number in the `README`
* [ ] Update `__version__` and `__release__` in `ranger/__init__.py`
* [ ] Update `__version__` in `ranger/ext/rifle.py`
* [ ] `make man`
* [ ] Write changelog entry
* [ ] Think of a witty commit message
* [ ] Commit
* [ ] Tag the signed release with `git tag -as vX.Y.Z`, using the same
      commit message as annotation
* [ ] Push release and tag

Make snapshot and test again
----------------------------
* [ ] Build `.tar.gz` with `make snapshot`
* [ ] `make`
* [ ] `make install`
* [ ] Test the snapshot one last time

Update the website
------------------
* [ ] Add the new version as `ranger-stable.tar.gz`
* [ ] Add the new version as `ranger-X.Y.Z.tar.gz`
* [ ] Update both signatures `gpg --local-user 0x00FB5CDF --sign --detach-sign <file>`
* [ ] Update the man page
    * [ ] run `make manhtml` in ranger's repository
    * [ ] copy the generated `doc/ranger.1.html` to the `ranger.github.io` repository
* [ ] Rebuild the website, see `README.md` in https://github.com/ranger/ranger.github.io
* [ ] Commit & push the website

Make a PyPI release
-------------------
* [ ] `git clean --force -d -x`
* [ ] `SETUPTOOLS_USE=1 python setup.py sdist`
* [ ] `gpg --local-user 0x00000000 --detach-sign --armor dist/*`
* [ ] `twine upload dist/*`

Announce the update
-------------------
* [ ] To the mailing list
* [ ] In the arch linux forum

Change back to before
---------------------
* [ ] Change `__release__` in `ranger/__init__.py` back to `False`
pan class="s">"number"} +transform: stash {stash_2_0: ("address" "array" "character")} :(scenario rewrite_traces_to_text) def main [ local-scope n:num <- copy 34 trace 2, [app], n ] +transform: {trace_2_2: ("address" "array" "character")} <- to-text-line {n: "number"} +transform: trace {2: "literal"}, {"app": "literal-string"}, {trace_2_2: ("address" "array" "character")} //: special case: rewrite attempts to stash contents of most arrays to avoid //: passing addresses around :(scenario rewrite_stashes_of_arrays) def main [ local-scope n:&:@:num <- new number:type, 3 stash *n ] +transform: {stash_2_0: ("address" "array" "character")} <- array-to-text-line {n: ("address" "array" "number")} +transform: stash {stash_2_0: ("address" "array" "character")} :(scenario ignore_stashes_of_static_arrays) def main [ local-scope n:@:num:3 <- create-array stash n ] +transform: stash {n: ("array" "number" "3")} :(scenario rewrite_stashes_of_recipe_header_products) container foo [ x:num ] def bar -> x:foo [ local-scope load-ingredients x <- merge 34 stash x ] +transform: stash {stash_2_0: ("address" "array" "character")} //: misplaced; should be in instruction inserting/deleting transforms, but has //: prerequisites: deduce_types_from_header and check_or_set_types_by_name :(after "Transform.push_back(deduce_types_from_header)") Transform.push_back(convert_ingredients_to_text); // idempotent :(code) void convert_ingredients_to_text(const recipe_ordinal r) { recipe& caller = get(Recipe, r); trace(9991, "transform") << "--- convert some ingredients to text in recipe " << caller.name << end(); // in recipes without named locations, 'stash' is still not extensible if (contains_numeric_locations(caller)) return; convert_ingredients_to_text(caller); } void convert_ingredients_to_text(recipe& caller) { vector<instruction> new_instructions; for (int i = 0; i < SIZE(caller.steps); ++i) { instruction& inst = caller.steps.at(i); // all these cases are getting hairy. how can we make this extensible? if (inst.name == "stash") { for (int j = 0; j < SIZE(inst.ingredients); ++j) { if (is_literal_text(inst.ingredients.at(j))) continue; ostringstream ingredient_name; ingredient_name << "stash_" << i << '_' << j << ":address:array:character"; convert_ingredient_to_text(inst.ingredients.at(j), new_instructions, ingredient_name.str()); } } else if (inst.name == "trace") { for (int j = /*skip*/2; j < SIZE(inst.ingredients); ++j) { if (is_literal_text(inst.ingredients.at(j))) continue; ostringstream ingredient_name; ingredient_name << "trace_" << i << '_' << j << ":address:array:character"; convert_ingredient_to_text(inst.ingredients.at(j), new_instructions, ingredient_name.str()); } } else if (inst.old_name == "append") { // override only variants that try to append to a string // Beware: this hack restricts how much 'append' can be overridden. Any // new variants that match: // append _:text, ___ // will never ever get used. if (is_literal_text(inst.ingredients.at(0)) || is_mu_text(inst.ingredients.at(0))) { for (int j = /*skip base*/1; j < SIZE(inst.ingredients); ++j) { ostringstream ingredient_name; ingredient_name << "append_" << i << '_' << j << ":address:array:character"; convert_ingredient_to_text(inst.ingredients.at(j), new_instructions, ingredient_name.str()); } } } trace(9993, "transform") << to_string(inst) << end(); new_instructions.push_back(inst); } caller.steps.swap(new_instructions); } // add an instruction to convert reagent 'r' to text in list 'out', then // replace r with converted text void convert_ingredient_to_text(reagent& r, vector<instruction>& out, const string& tmp_var) { if (!r.type) return; // error; will be handled elsewhere if (is_mu_text(r)) return; // don't try to extend static arrays if (is_static_array(r)) return; instruction def; if (is_lookup_of_address_of_array(r)) { def.name = "array-to-text-line"; reagent/*copy*/ tmp = r; drop_one_lookup(tmp); def.ingredients.push_back(tmp); } else { def.name = "to-text-line"; def.ingredients.push_back(r); } def.products.push_back(reagent(tmp_var)); trace(9993, "transform") << to_string(def) << end(); out.push_back(def); r.clear(); // reclaim old memory r = reagent(tmp_var); } bool is_lookup_of_address_of_array(reagent/*copy*/ x) { if (x.type->atom) return false; if (x.type->left->name != "address") return false; if (!canonize_type(x)) return false; return is_mu_array(x); } bool is_static_array(const reagent& x) { // no canonize_type() return !x.type->atom && x.type->left->atom && x.type->left->name == "array"; } :(scenarios run) :(scenario append_other_types_to_text) def main [ local-scope n:num <- copy 11 c:character <- copy 111/o a:text <- append [abc], 10, n, c expected:text <- new [abc1011o] 10:bool/raw <- equal a, expected ] //: Make sure that the new system is strictly better than just the 'stash' //: primitive by itself. :(scenario rewrite_stash_continues_to_fall_back_to_default_implementation) # type without a to-text implementation container foo [ x:num y:num ] def main [ local-scope x:foo <- merge 34, 35 stash x ] +app: 34 35