Skip to content

Commit 0e12f8f

Browse files
committed
docs: add details about use of git-cliff for releases
Signed-off-by: Pierre-Yves Lapersonne <[email protected]>
1 parent 44b3f75 commit 0e12f8f

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs_release/README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -128,13 +128,13 @@ You can also [look inside this commit](https://github.com/Orange-OpenSource/ouds
128128
<!-- TODO Update screenshot -->
129129
<!-- ![Edit GitHub release](images/github_release_01.png) -->
130130
131-
- Create a new tag X.Y.Z. **Warning, maybe git-cliff will need tag prefixed by v, so the documentation should be applied with this new rule**
131+
- Create a new tag X.Y.Z
132132
133133
<!-- TODO Update screenshot -->
134134
<!-- ![Create tag](images/github_release_02.png) -->
135135
136136
- Add release notes and verify using the preview tab.
137-
<!-- TODO Check with git-cliff release note generation and vTag prefix -->
137+
138138
- Optionally check `Set as a pre-release` and click `Publish release`. You can also create a disucssion from this release.
139139
140140
- Do not forget to update the documentation using `uploadWebDoc.sh` script. It will let a ZIP file of the documentation in */tmp* folder ; get this file and add it as release artifact, or if you want just download the sources from GitHub on *gh-pages* branch. You should also through Xcode build the documentation (_Product > Build Documentation_) and export each documentation catalog as documentation archive (doccarchive) (_Right click on catalog > Export_), compress all these files in one ZIP archive (GitHub consider them as empty so won't accept them for upload) and upload as artifact. In few words, put in release artifacts all the doccarchives in a ZIP in one side, and the HTML merged version in the other side.
@@ -143,6 +143,14 @@ You can also [look inside this commit](https://github.com/Orange-OpenSource/ouds
143143
144144
- From the GitLab CI pipeline job which made the production release, get the artifacts and put it in the release.
145145
146+
- You can use if you want *git-cliff* to build the release not to copy/paste in the release description
147+
148+
```shell
149+
# Where X is the previous tag and Y the new freshly created tag or HEAD
150+
# Run in main branch of course.
151+
git-cliff --config .github/cliff.toml --output RELEASE_NOTE.md X..Y
152+
```
153+
146154
- You can close the previous release dicussion, lock and unpin it. You should also pin the new discussion for the release, and add in comments the sprint number and the app details in production mode. [This is an excemple of a release discussion](https://github.com/Orange-OpenSource/ouds-ios/discussions/358) and [a detailed comment](https://github.com/Orange-OpenSource/ouds-ios/discussions/358#discussioncomment-11608399).
147155
148156
## Prepare Next Release

0 commit comments

Comments
 (0)