2022-08-26 15:50:21 +03:00
# Maintainer's Guide
2022-08-17 15:52:31 +03:00
2022-08-26 15:50:21 +03:00
## Making a release
### Rebuild generated files and documentation
2022-08-17 15:52:31 +03:00
The documentation and some generated files can be rebuilt by running
make -C doc rebuild
2022-08-26 15:50:21 +03:00
This requires `xsltproc` and the libxml2 Python bindings to be installed.
2022-08-17 15:52:31 +03:00
2022-08-26 15:50:21 +03:00
### Update the NEWS file
2022-08-17 15:52:31 +03:00
You can get started by running
git log --format='- %s (%an)' [previous-release-tag]..
2022-08-26 15:50:21 +03:00
### Bump the version number
2022-08-17 15:52:31 +03:00
Edit the version number in `configure.ac` if you haven't done so already.
2022-08-26 15:50:21 +03:00
### Build the tarball
2022-08-17 15:52:31 +03:00
I'd recommend to build the tarball by running
make distcheck
which performs some useful checks as well.
2022-08-26 15:50:21 +03:00
### Upload the tarball
2022-08-17 15:52:31 +03:00
Follow the instructions at
< https: / / wiki . gnome . org / MaintainersCorner / Releasing > :
scp libxml2-[version].tar.xz master.gnome.org:
ssh master.gnome.org ftpadmin install libxml2-[version].tar.xz
2022-08-26 15:50:21 +03:00
### Tag the release
2022-08-17 15:52:31 +03:00
Create an annotated tag and push it:
git tag -a [version] -m 'Release [version]'
git push origin [version]
2022-08-26 15:50:21 +03:00
### Create a GitLab release
2022-08-17 15:52:31 +03:00
Create a new GitLab release on
< https: / / gitlab . gnome . org / GNOME / libxml2 / - / releases > .
2022-08-26 15:50:21 +03:00
### Announce the release
2022-08-17 15:52:31 +03:00
Announce the release by sending an email to the mailing list at
xml@gnome.org.
2022-08-26 15:50:21 +03:00
## Updating the CI Docker image
Note that the CI image is used for libxslt as well. Run the following
2022-09-04 16:26:47 +03:00
commands with the Dockerfile in the .gitlab-ci directory:
2022-08-26 15:50:21 +03:00
docker login registry.gitlab.gnome.org
2022-09-04 16:26:47 +03:00
docker build -t registry.gitlab.gnome.org/gnome/libxml2 - \
< .gitlab-ci / Dockerfile
2022-08-26 15:50:21 +03:00
docker push registry.gitlab.gnome.org/gnome/libxml2