Skip to content

Commit e5ba303

Browse files
committed
Add screenshots and more details to the release procedure
1 parent f88cc8a commit e5ba303

6 files changed

Lines changed: 12 additions & 3 deletions
1.2 MB
Loading
1000 KB
Loading
1.02 MB
Loading

images/Push_tags_in_Tower.png

1.13 MB
Loading
1.03 MB
Loading

proof/SpellerReleaseProcedures.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,41 @@ and for using the command line).
1010
1. Make sure your git version is up to date: commit own changes,
1111
**pull to last version**, push eventual own changes to get a
1212
**clean version**.
13-
1. Update the speller version number constant `SPELLERVERSION` in `configure.ac`, using [semantic versioning](https://semver.org):
13+
1. Update the speller version number constant `SPELLERVERSION` in `configure.ac` (`GRAMCHECKVERSION` if releasing a new grammar checker version), using [semantic versioning](https://semver.org):
1414
- MAJOR version = incompatible changes, and going from beta to release (from `0.x.x` to `1.x.x`)
1515
- MINOR version = new / more words
1616
- PATCH version = actual bug fixes
17+
- General rule: never touch the first number
1718
1. Make sure that the new version is also recorded in `manifest.toml`,
1819
either by editing manually, or (the safer option) by running `make`
1920
after changing `configure.ac` ( both these files are found in
2021
`lang-xxx`, xxx being the iso code of your language).
2122
1. Go to Tower and commit the changes to both `configure.ac` and
2223
`manifest.toml` *in one common commit*, but **do not push yet**
24+
- This is what it should look like in Tower:
25+
![Version update in Tower](../images/Tower_new_grammar_checker_version.png)
2326
1. create a new GIT tag for the release, as follows::
2427
1. click on the **main** branch in Tower (in the left menu). The
2528
commit you just made for confiugre.ac and manifest.toml should
2629
be on the top of the list.
2730
2. Right-click on that commit version and choose *Create New Tag
2831
From*.
2932
3. In the **Name** field, write the name of the new release, using the following pattern:
30-
"`speller-`" plus *language code* plus `/` plus`v` plus *the
33+
"`speller-`" (or `grammar-` if that is what you release) plus *language code* plus `/` plus`v` plus *the
3134
version string you just committed*. If the newly committed version
3235
string is `1.2.3` and the language code is `fao`, you should add the tag `speller-fao/v1.2.3`
3336
4. Click on **Create Tag**. The new wersion will now appear under
3437
the **Tags** speller-xxx menu to the left (where xxx is your iso code)
38+
- This is what it should look like in Tower:
39+
![Create tag in Tower, step 1](../images/Create_git_tag_in_Tower_1.png) <br/>
40+
![Create tag in Tower, step 2](../images/Create_git_tag_in_Tower_2.png) <br/>
41+
![Create tag in Tower, step 3](../images/Create_git_tag_in_Tower_3.png)
3542
1. Click on the usual **Push** button. Open **Options** to make sure
3643
that `Push all tags` is chosen, and click **Push**
44+
- what it should look like in Tower:
45+
![Push tag in Tower](../images/Push_tags_in_Tower.png)
3746
1. Now, the new speller version should be visible in
38-
[divvun.uit.no](https://divvun.uit.no) within appr. 10 minutes.
47+
[divvun.uit.no](https://divvun.uit.no) within appr. 10 minutes, grammar checkers within 30-60 minutes.
3948

4049
Additional comments:
4150

0 commit comments

Comments
 (0)