15 Release Checklist

El RIDO edited this page 2025-06-28 22:06:17 +02:00

Table of Contents

• Preparations
• Release

This is an internal checklist of things not to forget before releasing a new PrivateBin version.

Preparations

1. update README.md, CHANGELOG.md, CREDITS.md and doc/Installation.md
2. increment version number: make increment VERSION=1.2.3
3. rerun a full phpunit test suite: make test
4. manually retest key functions on a site with the latest code, especially looking for visual glitches.
5. update SRI hashes, which is necessary after incrementing the version number in the JS sources
6. test git archive generation, it should not contain directories tst or doc. Things that should be ignored can be configured in .gitattributes

Release

1. tag latest release as a signed tag, push it to github, sign the release archives and update the release page with the latest CHANGELOG.md entry: make sign VERSION=1.2.3
2. generate coverage reports & API docs using make coverage doc and publish into the pelican repository
3. check that configuration wiki page is still up to date
4. update screenshots for all templates and replace those on the template wiki page
5. Update frontpage of the project site based on README.md in the pelican repository
6. update the docker containers
7. update the stable demo site
8. announce the release
9. update the version in helm-chart/charts/privatebin/Chart.yaml

• Project Home
• Instance Directory
• Third Party Clients
• Overview:
  • Configuration
  • FAQ
  • Monitoring
• Development:
  • API
  • Encryption format
  • Templates
  • Translation
  • Threat Model
  • Release Checklist
• Installation Methods:
  • Docker
  • MS IIS
  • RedHat with SELinux
  • Restrict upload using NGINX
  • Other installation methods

Copyright 2021 wiki contributors. Licensed under CC BY 4.0. The PrivateBin software itself is licensed differently.