Commit aa0c5e4
authored
Partially automate release - tagging and documentation generation [DI-669] (#1362)
_Partially_ automates the steps listed in [the `C++ Client Release
Process`
documentation](https://hazelcast.atlassian.net/wiki/spaces/HZC/pages/129810774/C+Client+Release+Process).
Specifically, steps:
- `Git tagging`
- `Doxygen`
By scripting and chaining the steps, the (manual) release work is
reduced and consistency is improved. Tagging logic based on [approach in
`hazelcast-docker`](https://github.com/hazelcast/hazelcast-docker/blob/master/.github/workflows/retag.yml).
Where possible, I've tried to replicate how it _currently_ works. It's
likely there's future scope to improve (e.g. should the documentation
updates _really_ raise a PR?).
Of note - the instructions call for an "annotated tag" (`tag -a`). While
this [seems more sensible](https://stackoverflow.com/q/4971746), it's
not [how we make tags
elsewhere](https://github.com/search?q=org%3Ahazelcast%20%22git%20tag%22&type=code)
(most notably - [in the release
pipeline](https://github.com/hazelcast/hazelcast-pipeline-library/blob/43882a84b3715e2ac74f84c92f3c3d170504f2ab/src/com/hazelcast/qe/pipeline/git/Branch.groovy#L122-L127)),
so for consistency I've changed to lightweight tags.
Testing (in my fork):
- [example
execution](https://github.com/JackPGreen/hazelcast-cpp-client/actions/runs/19150806835)
- [tag
created](https://github.com/JackPGreen/hazelcast-cpp-client/releases/tag/v5.5.3)
- [documentation PR
raised](JackPGreen#4)
Post-merge actions:
- [ ] update docs
_Partially addresses_:
[DI-669](https://hazelcast.atlassian.net/browse/DI-669)
[DI-669]:
https://hazelcast.atlassian.net/browse/DI-669?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ1 parent 8ed713f commit aa0c5e4
1 file changed
+87
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
0 commit comments