diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..83af1384 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +!release diff --git a/docs/misc/release/create-new-release.md b/docs/misc/release/create-new-release.md new file mode 100644 index 00000000..5fac8fab --- /dev/null +++ b/docs/misc/release/create-new-release.md @@ -0,0 +1,19 @@ +--- +layout: default +title: Create a new release +parent: Release +grand_parent: Miscellaneous +nav_order: 1 +--- + +# Release Preparation Checklist + +Follow the steps in the checklist below to prepare a new release. + +- [ ] 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. +- [ ] Update ./install.sh `@version` in header if the install script has changed. This allows the install script to self-update when running ./install.sh update command on default installations. +- [ ] Update README screenshots if applicable +- [ ] Update README current/upcoming features + +Optional steps: +- [ ] Update /docs instructions if any changes have been made to the setup process diff --git a/docs/misc/release/index.md b/docs/misc/release/index.md new file mode 100644 index 00000000..21039a87 --- /dev/null +++ b/docs/misc/release/index.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Release +parent: Miscellaneous +nav_order: 1 +---