File: RELEASING.md

package info (click to toggle)
check-pgbackrest 1.9-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 716 kB
  • sloc: sh: 1,238; perl: 868; makefile: 41; sql: 25
file content (158 lines) | stat: -rw-r--r-- 3,869 bytes parent folder | download
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# Releasing

## Source code

Edit variable `$VERSION` in `check_pgbackrest`, and update the version field 
at the end of the in-line documentation in this script.

Use date format `LC_TIME=C date +"%a %b %d %Y"`.

In `check_pgbackrest.spec`:
  * update the tag in the `_tag` variable (first line)
  * update the version in `Version:`
  * edit the changelog

Update the `CHANGELOG.md` file too.

Update the tests results `test/regress/expected/version.out`.

## Documentation

Generate updated documentation:

```bash
pod2text check_pgbackrest > README
podselect check_pgbackrest > README.pod
```

## Tagging and building tar file

```bash
TAG=REL1_9
git tag -a $TAG -m "Release $TAG"
git tag
git push --tags
git archive --prefix=check_pgbackrest-$TAG/ -o /tmp/check_pgbackrest-1.9.tar.gz $TAG
```

## Release on github

  - Go to https://github.com/dalibo/check_pgbackrest/releases
  - Edit the release notes for the new tag
  - Set "check_pgbackrest $VERSION" as title, eg. "check_pgbackrest 1.9"
  - Here is the format of the release node itself:
    YYYY-MM-DD - Version X.Y
    
    Changelog:
      * item 1
      * item 2
      * ...
      
  - Upload the tar file
  - Save
  - Check or update https://github.com/dalibo/check_pgbackrest/releases

## Building the RPM file

### Installation

```bash
yum group install "Development Tools"
yum install rpmdevtools
useradd makerpm
```

### Building the package

```bash
su - makerpm
rpmdev-setuptree
git clone https://github.com/dalibo/check_pgbackrest.git
spectool -R -g check_pgbackrest/check_pgbackrest.spec
rpmbuild -ba check_pgbackrest/check_pgbackrest.spec
```

The RPM is generated into `rpmbuild/RPMS/noarch`.

Don't forget to upload the package on GitHub release page.

### Vagrant

A specific Vagrant script has been created in the `packaging` directory to 
build the rpm. To launch it, go the the `packaging` directory and execute:

```bash
make all
```

## Community

### pgsql-announce

Send a mail to the pgsql-announce mailing list. Eg.:

```
check_pgbackrest 1.9 has been released

check_pgbackrest is designed to monitor pgBackRest backups from Nagios, 
relying on the status information given by the "info" command.

It allows to monitor the backups retention and the consistency of the 
archived WAL segments.

Changes in check_pgbackrest 1.9:
  - ...
  - ...

===== Links & Credits =====

check_pgbackrest is an open project, licensed under the PostgreSQL license.
Any contribution to improve it is welcome.

Links:
  - Download: https://github.com/dalibo/check_pgbackrest/releases
  - Support: https://github.com/dalibo/check_pgbackrest/issues
```

### Submit a news on postgresql.org

* organisation: Dalibo
* Title: "check_pgbackrest 1.9 has been released"
* Content:
  
```
_Town, Country, Month xx, 2020_

`check_pgbackrest` is designed to monitor [pgBackRest](https://pgbackrest.org) 
backups from Nagios, relying on the status information given by the 
[info](https://pgbackrest.org/command.html#command-info) command.

It allows to monitor the backups retention and the consistency of the archived 
WAL segments.

Changes in check_pgbackrest 1.9
------------------------------------------------------------------------------

  * ...
  * ...

Links & Credits
--------------------------------------------------------------------------------

`check_pgbackrest` is part of the [Dalibo Labs] initiative. It is mainly 
developed by [Stefan Fercot].
This is an open project, licensed under the PostgreSQL license. 
Any contribution to improve it is welcome.

Links:

  * [Download]: https://github.com/dalibo/check_pgbackrest/releases
  * [Support]: https://github.com/dalibo/check_pgbackrest/issues

Note: RPM package is available on the GitHub Release page. 

[Dalibo Labs]: https://labs.dalibo.com
[Stefan Fercot]: https://www.dalibo.com/en/equipe#stefan
```
  
* check "Related Open Source"