docs: Add in some documentation on packaging and the release process Change-Id: I8afdfb1689b5344cb5b0f692a8d90949f4fadf1d
diff --git a/PackagingGuide.md b/PackagingGuide.md new file mode 100644 index 0000000..72ad79c --- /dev/null +++ b/PackagingGuide.md
@@ -0,0 +1,24 @@ +# Version Numbering + +## Upstream + +<software-version>[-<upstream-package-version>]mendel<package-version> + +upstream-package-version is optional if upstream doesn't have a package version. +If it is present, it must be prefixed with a single dash. + +## Mendel packages + +<software-version>-<package-version> + +# Package Naming + +Package names should be using a methodical naming convention. + +Board specific packages should be named "<boardname>-board-<packagename>". In +the case of enterprise, we use "imx" as the board name for historical reasons. + +Python packages that provide libraries should use the upstream Debian naming +with "python3-" or "python-" as the package name. + +Mendel specific packages should be named "mendel-<packagename>".
diff --git a/ReleaseProcess.md b/ReleaseProcess.md new file mode 100644 index 0000000..ece1bca --- /dev/null +++ b/ReleaseProcess.md
@@ -0,0 +1,22 @@ +# Release Process + +1. Update the packages kokoro job to point to the latest release +2. Update all or some of the package version numbers + - All of the package changelogs need to have the proper release listed in the + changelog after the package number. +3. Create the release branch in all projects +4. Create the release branch in continuous-build +5. All package repositories we have updated need to have git tags + - Format of the tag is the same as the package version in the + debian/changelog file. +6. Run the packages kokoro job on beaker + - Looks at the beaker branch looking for the latest versions and updates that way +7. Tag the latest rapture with the beaker tag. + +Cherry picks: +1. Commit to master +2. Cherry pick to next branch +3. All packages we have updated need to have tags +4. Run the packages kokoro job on next + - Looks at the next branch looking for the latest versions and updates that way +5. Tag the latest rapture with the next tag.