Skip to content

Commit

Permalink
docs: add some details about releases
Browse files Browse the repository at this point in the history
Signed-off-by: Pierre-Yves Lapersonne <[email protected]>
  • Loading branch information
pylapp committed Oct 31, 2024
1 parent d469cb1 commit 87d1526
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions docs_release/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ This file lists all the steps to follow when releasing a new version of OUDS iOS

- Create a new pull request named `Release X.Y.Z` on GitHub to merge `develop` into `main`.

- Review and merge this pull request on GitHub. The merge strategy must be a **simple merge without squash of commits** (this strategy is only dedicated to feature branches to merge in develop branch). The _merge commit_ can be defined so as to bring details about the merge and make links automatically with GitHub issues. To do that, you can copy/paste the content of the changelog (after the version line) and uncomment (i.e. remove # symbols) lines. Thus if in the commit message body any issue is referenced, it will appear in the associated issue. Do not forget also to add people as co-authors if needed.
- Review and merge this pull request on GitHub. The merge strategy must be a **simple merge without squash of commits**, i.e. "create a merge commit". Rebase should be used to align feature branches with default one, and squash should be used when needed for work branches. The _merge commit_ can be defined so as to bring details about the merge and make links automatically with GitHub issues. To do that, you can copy/paste the content of the changelog (after the version line) and uncomment (i.e. remove # symbols) lines. Thus if in the commit message body any issue is referenced, it will appear in the associated issue. Do not forget also to add people as co-authors if needed.

Below is an example of what should be a merge commit in `main` branch for a release (ignore of course // lines, see [this commit for example](https://github.com/Orange-OpenSource/ouds-ios/commit/98640b4b63037c2780128f41ceba5b896763b94f)):

Expand All @@ -86,12 +86,16 @@ Removed:
Fixed:
- [Library] Fix some typos in documentation ([#89](#89))
// Add in co authors anyone working on the commits being merged
Co-authored-by: Ludovic Pinel <[email protected]>
Co-authored-by: Pierre-Yves Lapersonne <[email protected]>
// Add in co authors anyone working on the commits being merged, add the ones who contributed (copy-paste if too lazy)
Co-authored-by: Julien Déramond <[email protected]>
Co-authored-by: Pierre-Yves Lapersonne <[email protected]>
Co-authored-by: Ludovic Pinel <[email protected]>
Co-authored-by: Tayeb Sedraia <[email protected]>
Co-authored-by: boosted-bot <[email protected]>
```
You can also [look inside this commit](https://github.com/Orange-OpenSource/ouds-ios/commit/5ce9b68aa03304fef91fc45ef43a379b4f22f98b) for example.
- Generate documentation: from Xcode build the doc, export each doccarchive, then rnu the script ; it will update online version and generate a ZIP file in _/tmp_
```shell
./uploadWebDoc.sh --libversion=X.Y.Z --usegit
Expand Down Expand Up @@ -137,7 +141,6 @@ Co-authored-by: Julien Déramond <[email protected]>
<!-- TODO Check with git-cliff release note generation and vTag prefix -->
- Optionally check `Set as a pre-release` and click `Publish release`.<br /><br />
<!-- TODO Section about annoucement -->
<!--
### Announce the new release on FoODS
Expand Down Expand Up @@ -168,6 +171,8 @@ Co-authored-by: Julien Déramond <[email protected]>
- Clone the [wiki](https://github.com/Orange-OpenSource/ouds-ios/wiki) (available at https://github.com/Orange-OpenSource/ouds-ios.wiki.git), compress its content as ZIP, and place the ZIP in release artifacts
- From the GitLab CI pipeline job which made the production release, get the artifacts and put it in the release.
## Prepare Next Release
- Create a branch named `prepare-new-release` to prepare the new release for OUDS iOS version U.V.W.
Expand Down

0 comments on commit 87d1526

Please sign in to comment.