| ... | ... | @@ -315,3 +315,70 @@ and check that the modified functionalities work properly again. |
|
|
|
### Reminder
|
|
|
|
|
|
|
|
Each function in the folder `R` has a corresponding .Rd file in the `man` folder, and the text in the .Rd will be used to generate the user manual and will appear when you type `?FunctionName`.
|
|
|
|
|
|
|
|
### Maintenance
|
|
|
|
|
|
|
|
#### Branch naming conventions
|
|
|
|
|
|
|
|
Main branch: master
|
|
|
|
|
|
|
|
Development branches: develop-feature or feature
|
|
|
|
|
|
|
|
Bugfix branches: develop-bugfixes-2.3.1 (when last release was 2.3.1)
|
|
|
|
|
|
|
|
Docfix branches: develop-docfixes-2.3.1 (when last release was 2.3.1)
|
|
|
|
|
|
|
|
Hotfix branches: develop-hotfixes-2.3.1-a (when last release was 2.3.1)
|
|
|
|
|
|
|
|
Upgrade branches: develop-upgrade-to-2.3.2 (when last release was 2.3.1)
|
|
|
|
|
|
|
|
Version numbers will be bumped as described in the Semantic Versioning conventions. See http://semver.org.
|
|
|
|
#### Steps to release
|
|
|
|
|
|
|
|
1- Check all open issues to see if some can be solved easily before releasing.
|
|
|
|
|
|
|
|
2- Open MR for all open bugfix branches.
|
|
|
|
|
|
|
|
3- Open MR for all open docfix branches.
|
|
|
|
|
|
|
|
4- Open MR for all open hotfix branches.
|
|
|
|
|
|
|
|
5- Close all MRs possible. For each:
|
|
|
|
|
|
|
|
```
|
|
|
|
- run test script before accepting
|
|
|
|
- ls -la everywhere to check no trash/huge files leak into master. Update .gitignore and - Rbuildignore if needed
|
|
|
|
- accept (removing source branch)
|
|
|
|
- git checkout master
|
|
|
|
- git fetch origin
|
|
|
|
- git pull
|
|
|
|
```
|
|
|
|
|
|
|
|
6- Run test script. Then run manually R CMD check without parameter –-no-examples and with parameter -–as-cran if releasing on CRAN. Try to include in test scripts all bugs detected since last release.
|
|
|
|
|
|
|
|
7- If small errors appear, fix in for example develop-hotfixes-2.3.1-b and go to 3-.
|
|
|
|
|
|
|
|
8- Open upgrade branch and open MR and merge as in 4-. Update at least:
|
|
|
|
|
|
|
|
```
|
|
|
|
- DESCRIPTION (date, version, dew depends, new authors)
|
|
|
|
- NAMESPACE (new depends)
|
|
|
|
- man/package-s2dverification.Rd
|
|
|
|
- pdf
|
|
|
|
```
|
|
|
|
|
|
|
|
9- Submit on CRAN.
|
|
|
|
|
|
|
|
10- Create a tag (if from GitLAB, do a 'git fetch origin' after).
|
|
|
|
|
|
|
|
11- Add any special messages in R code or add log-registering commands.
|
|
|
|
|
|
|
|
12- Build and install in /cfu/software, and in amdahl and in moore for each module possible.
|
|
|
|
|
|
|
|
13- Send release e-mail to s2dverification list, with all news since previous release.
|
|
|
|
|
|
|
|
14- Update change log on wiki page.
|
|
|
|
|
|
|
|
### Style Guide
|
|
|
|
|
|
|
|
You can check the style guide for the s2dverification package here |
