Make a release with git flow

Make a release with git-flow

git-flow are a set of git extensions to provide high-level repository operations for Vincent Driessen's branching model. source website

Before started, be sure that develop branch is up-to-date with the remote repository branch.

git checkout develop
git pull

1. Start the release
   Run the following command line :
   git flow release start vX.X.X
   It will create a branch release from the branch develop.

2. Modify version in the DESCRIPTION file.

3. Check if the tests contains in the Makefile are OK.
   make all

   Specificity with a container...
   Run the make all command line in the Rstudio terminal from the container.

4. Generate the html vignette
   Go to the folder related to the branch html_doc.
   Open the docs/index.Rmd in Rstudio (from the related container).
   Generate the documentation clicking on the knit button. (Don't forget to modify the path for setwd())
   Check if the vignette is correct.

5. Add modification to the changelog.md
   If it's not already done, add the modification/new functionalities to the changelog.md files related to the good version number.

6. Finish up the release Run the following command line :
   git flow release finish vX.X.X
   It merges the release branch back into main, tags the release with its name, back-merges the release into the branch develop and removes the release branch.
   Don't forget to add a message related to the description of the modification added.

7. Push modification to the remote repository

git push develop
git checkout main
git push main
git tag
git push origin vX.X.X

8. Update the release version on github
   In the main page of the repository, click on "tags" -> "release" -> "Draft a new release".
   Select the tag and name it (adjective + animal).
   Add a description of the modifications.
   Click on "release".