mirror of https://github.com/aliasvault/aliasvault.git synced 2026-03-20 23:52:31 -04:00

Files

Leendert de Borst d674563275 Update docs (#541 )

2025-02-20 22:13:54 +01:00

layout, title, parent, grand_parent, nav_order

layout	title	parent	grand_parent	nav_order
default	Create a new release	Release	Miscellaneous	1

Release Preparation Checklist

Follow the steps in the checklist below to prepare a new release.

Versioning client and server

Update ./src/Shared/AliasVault.Shared.Core/AppInfo.cs and update major/minor/patch to the new version. This version will be shown in the client and admin app footer. This version should be equal to the git release tag.
Update ./src/Shared/AliasVault.Shared.Core/AppInfo.cs with the minimum supported client versions (in case API output breaks earlier client versions).
Update ./install.sh @version in header if the install script has changed. This allows the install script to self-update when running the ./install.sh update command on default installations.
Update README.md install.sh download link to point to the new release version

Update ./chrome/manifest.json with the new version for the extension. This will be shown in the Chrome Web Store. This version should be equal to the git release tag.
Update ./chrome/src/shared/AppInfo.ts with the new version for the extension. This version should be equal to the git release tag.
Update ./chrome/src/shared/AppInfo.ts with the minimum supported server version (in case of required API breaking changes).
Update ./chrome/src/shared/AppInfo.ts with the minimum supported client vault version (in case of required client vault model changes).

If docker containers have been added or removed:

Verify that .github/workflows/publish-docker-images.yml contains references to all docker images that need to be published.
Update install.sh and verify that the images=() array that takes care of pulling the images from the GitHub Container Registry is updated.

Verify that the db migration from SQLite to PostgreSQL works. This needs to be tested manually until the SQLite support is removed. Test with: ./install.sh db-migrate on an existing installation that has a SQLite database in ./database/AliasServerDb.sqlite.