Skip to content

Commit 3e89d39

Browse files
snisni
committed
add release docs
1 parent c6abd65 commit 3e89d39

File tree

2 files changed

+181
-3
lines changed

2 files changed

+181
-3
lines changed

‎src/documentation/developer/releases.md‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
# How To Release
2+
3+
## Prerequisites
4+
5+
### Check Build Status
6+
7+
Make sure all builds and CI pipelines are green.
8+
9+
- [naemon-core](https://github.com/naemon/naemon-core) / [ci pipeline](https://github.com/naemon/naemon-core/actions/workflows/citest.yml)
10+
- [naemon-livestatus](https://github.com/naemon/naemon-livestatus) / [ci pipeline](https://github.com/naemon/naemon-livestatus/actions/workflows/citest.yml)
11+
- [naemon-vimcrypt](https://github.com/naemon/naemon-vimcrypt-vault-broker)
12+
13+
## Create Releases
14+
15+
### Naemon Core
16+
17+
1. Create release commit:
18+
19+
```shell
20+
%> # git clone https://github.com/naemon/naemon-core
21+
%> cd naemon-core
22+
%> git pull
23+
%> make clean
24+
%> make version
25+
%> vim NEWS
26+
%> git commit -avs -m "release v<VERSION>"
27+
%> git tag "v<VERSION>"
28+
%> git push
29+
%> git push --tags
30+
```
31+
32+
2. Wait for pipeline actions on [GitHub](https://github.com/naemon/naemon-core/actions).
33+
34+
3. Then create release on [naemon core releases](https://github.com/naemon/naemon-core/releases).
35+
36+
Use the tag name as title and the news entry as description.
37+
38+
4. Update OSB Builds
39+
40+
```shell
41+
%> # osc checkout "home:naemon"
42+
%> cd home:naemon/naemon-core
43+
%> osc up
44+
%> vim _service # replace version number
45+
%> osc commit
46+
```
47+
48+
5. Wait for builds to complete on [build.opensuse.org/home:naemon](https://build.opensuse.org/package/show/home:naemon/naemon-core).
49+
50+
### Naemon Livestatus
51+
52+
1. Create release commit:
53+
54+
```shell
55+
%> # git clone https://github.com/naemon/naemon-livestatus
56+
%> cd naemon-core
57+
%> git pull
58+
%> make clean
59+
%> make version
60+
%> git commit -avs -m "release v<VERSION>"
61+
%> git tag "v<VERSION>"
62+
%> git push
63+
%> git push --tags
64+
```
65+
66+
2. Wait for pipeline actions on [GitHub](https://github.com/naemon/naemon-livestatus/actions).
67+
68+
3. Then create release on [naemon livestatus releases](https://github.com/naemon/naemon-livestatus/releases).
69+
70+
Use the tag name as title and the news entry as description.
71+
72+
4. Update OSB Builds
73+
74+
```shell
75+
%> # osc checkout "home:naemon"
76+
%> cd home:naemon/naemon-livestatus
77+
%> osc up
78+
%> vim _service # replace version number
79+
%> osc commit
80+
```
81+
82+
5. Wait for builds to complete on [build.opensuse.org/home:naemon](https://build.opensuse.org/package/show/home:naemon/naemon-livestatus).
83+
84+
### Naemon Vim Vault
85+
86+
1. Create release commit:
87+
88+
```shell
89+
%> # git clone https://github.com/naemon/naemon-vimcrypt-vault-broker
90+
%> cd naemon-vimcrypt-vault-broker
91+
%> git pull
92+
%> make clean
93+
%> make version
94+
%> git commit -avs -m "release v<VERSION>"
95+
%> git tag "v<VERSION>"
96+
%> git push
97+
%> git push --tags
98+
```
99+
100+
2. Then create release on [naemon vimvault releases](https://github.com/naemon/naemon-vimcrypt-vault-broker/releases).
101+
102+
Use the tag name as title and the news entry as description.
103+
104+
3. Update OSB Builds
105+
106+
```shell
107+
%> # osc checkout "home:naemon"
108+
%> cd home:naemon/naemon-vimvault
109+
%> osc up
110+
%> vim _service # replace version number
111+
%> osc commit
112+
```
113+
114+
4. Wait for builds to complete on [build.opensuse.org/home:naemon](https://build.opensuse.org/package/show/home:naemon/naemon-vimvault).
115+
116+
### Naemon Meta Package
117+
118+
1. Create release commit:
119+
120+
```shell
121+
%> # git clone https://github.com/naemon/naemon
122+
%> cd naemon
123+
%> git pull
124+
%> make clean
125+
%> make version
126+
%> git commit -avs -m "release v<VERSION>"
127+
%> git tag "v<VERSION>"
128+
%> git push
129+
%> git push --tags
130+
```
131+
132+
2. Wait for pipeline actions on [GitHub](https://github.com/naemon/naemon/actions/workflows/citest.yml).
133+
134+
3. Then create release on [naemon releases](https://github.com/naemon/naemon/releases).
135+
136+
Just use the auto-generate button.
137+
138+
4. Update OSB Builds
139+
140+
```shell
141+
%> # osc checkout "home:naemon"
142+
%> cd home:naemon/naemon
143+
%> osc up
144+
%> vim _service # replace version number
145+
%> osc commit
146+
```
147+
148+
5. Wait for builds to complete on [build.opensuse.org/home:naemon](https://build.opensuse.org/package/show/home:naemon/naemon).
149+
150+
### naemon.io
151+
152+
1. Create release update:
153+
154+
```shell
155+
%> # git clone github.com/naemon/naemon.github.io
156+
%> cd naemon.github.io
157+
%> git pull
158+
%> vim src/.env # adjust date and version
159+
%> vim src/download.md # double check available distributions
160+
%> vim src/documentation/usersguide/whatsnew.md # add changelog entry
161+
%> vim src/news/<date>-release-<v>.md # add news entry
162+
%> git commit -avs -m "release v<VERSION>"
163+
%> git push
164+
```
165+
166+
## Socialize
167+
168+
Communicate the release on various channels:
169+
170+
- [mastodon](https://floss.social/@naemon)
171+
172+
## Other
173+
174+
If there had been API changes, 3rd party NEB modules have to be rebuild, ex.:
175+
176+
- mod-gearman neb module
177+
- status engine

‎src/documentation/developer/website.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ The Naemon Website is build with [VitePress](https://vitepress.dev) and can run
77

88
### Prerequisites
99

10-
- [Node.js](https://nodejs.org/) version 18 or higher.
11-
- Text Editor with [Markdown](https://en.wikipedia.org/wiki/Markdown) syntax support.
12-
- [Visual Studio Code](https://code.visualstudio.com/) for example.
10+
- [Node.js](https://nodejs.org/) version 18 or higher.
11+
- Text Editor with [Markdown](https://en.wikipedia.org/wiki/Markdown) syntax support.
12+
- [Visual Studio Code](https://code.visualstudio.com/) for example.
1313

1414
```bash
1515
git clone https://github.com/naemon/naemon.github.io.git
@@ -19,6 +19,7 @@ npm install
1919
```
2020

2121
Now you are ready to start the development server
22+
2223
```bash
2324
npm run docs:dev
2425
```

0 commit comments

Comments
 (0)