Document the need for ~/altusmetrumllc/google-maps-api-key
[fw/altos] / Releasing
index 973cb01f6a098c850e39d3e26292b62341f31d6d..8b30600771f7fddd686ae5d3a56052be58b59b5e 100644 (file)
--- a/Releasing
+++ b/Releasing
@@ -7,20 +7,30 @@ These are Bdale's notes on how to do a release.
          and add release to the revision history at the front (release notes
          will be pulled in automatically)
 
          and add release to the revision history at the front (release notes
          will be pulled in automatically)
 
+       - get a Google Maps API key and install it in
+          ~/altusmetrumllc/google-maps-api-key. If you don't have a
+          key, the app will still work, but downloading map tiles will
+          be slow, and you will only be able to download a limited
+          number per day.
+
        - update the version in configure.ac
         git log > ChangeLog
        git commit -a
        - update the version in configure.ac
         git log > ChangeLog
        git commit -a
+
        - make absolutely sure checked-out tree is "clean" 
        - make absolutely sure checked-out tree is "clean" 
+       - make absolutely sure the pdclib/ submodule is on the master branch,
+         up to date, and "clean"
+
        - if this is an x.y release, then:
                git checkout -b branch-<version>
                git tag -a <version>
        - if this is an x.y release, then:
                git checkout -b branch-<version>
                git tag -a <version>
+               - edit .git/gbp.conf to use branch-<version> as upstream
+
        - if this is an x.y.z release, then:
                git checkout branch-<version>           # the x.y parts only
                git merge master
                git tag -a <version>                    # full x.y.z version
 
        - if this is an x.y.z release, then:
                git checkout branch-<version>           # the x.y parts only
                git merge master
                git tag -a <version>                    # full x.y.z version
 
-       - edit .git/gbp.conf to use branch-<version> as upstream if needed
-
        git checkout debian
        git merge branch-<version>
 
        git checkout debian
        git merge branch-<version>
 
@@ -31,12 +41,14 @@ These are Bdale's notes on how to do a release.
         git commit -n debian/changelog -m "update changelog for Debian build"
 
        - if this is a -1 release, then
         git commit -n debian/changelog -m "update changelog for Debian build"
 
        - if this is a -1 release, then
-               git-buildpackage --git-no-pristine-tar 
+               git-buildpackage --git-no-pristine-tar --git-submodules \
+                       --git-upstream-branch=branch-<version> \ # eg 1.3
+                       --git-upstream-tag=<version>             # eg 1.3.1
                pristine-tar commit \
                pristine-tar commit \
-                       ../build-area/altos/altos_<version>.orig.tar.gz \
+                       ../build-area/altos_<version>.orig.tar.gz \
                        branch-<version>
          else if this is not a -1 release
                        branch-<version>
          else if this is not a -1 release
-               git-buildpackage
+               git-buildpackage --git-submodules
 
        git tag debian/<version>
 
 
        git tag debian/<version>
 
@@ -50,19 +62,34 @@ These are Bdale's notes on how to do a release.
 
                this pushes packages for each platform to web site
 
 
                this pushes packages for each platform to web site
 
+       # store a stable copy of ARM binaries for production use
+       cp src/easymini-v1.0/*.elf \
+          src/telemega-v1.0/*.elf \
+          src/telemetrum-v2.0/*.elf \
+          ~/altusmetrumllc/Binaries/
+       cp src/easymini-v1.0/flash-loader/*.elf \
+          src/telemega-v1.0/flash-loader/*.elf \
+          src/telemetrum-v2.0/flash-loader/*.elf \
+          ~/altusmetrumllc/Binaries/loaders/
+       (cd ~/altusmetrumllc ; git commit -a) 
+
        - copy the relevant release notes file from doc/ to 
            /home/bdale/web/altusmetrum/AltOS/releases/<rev>
 
        - copy the relevant release notes file from doc/ to 
            /home/bdale/web/altusmetrum/AltOS/releases/<rev>
 
-       - go edit ~/web/altusmetrum/AltOS/releases/<rev>.mdwn to include
-         release date and explicit ref to dir contents so the AltOS page
-         shows versioned links, commit and push
+       - create /home/bdale/web/altusmetrum/MicroPeak/releases/<rev>,
+         and move the MicroPeak installers from AltOS/releases to there
+               
+       - go edit ~/web/altusmetrum/AltOS/releases/<rev>.mdwn and 
+         /home/bdale/web/altusmetrum/MicroPeak/releases/<rev>.mdwn, to 
+         include release date and explicit ref to dir contents so the 
+         web pages shows versioned links, commit and push
 
        (cd doc ; make publish)
 
                this pushes fresh documents to the web site
 
        sudo debian/rules clean
 
        (cd doc ; make publish)
 
                this pushes fresh documents to the web site
 
        sudo debian/rules clean
-       git push origin master branch-1.1 debian
+       git push origin master branch-<version> debian pristine-tar
        git push --tags
 
                push commits and leave the build tree in an uncluttered state
        git push --tags
 
                push commits and leave the build tree in an uncluttered state