argh, immediately needs fix for success message
[feisty_meow.git] / scripts / rev_control / quick_git_release.sh
1 #!/bin/bash
2
3 # a simple and quick method for making a new release, merging it into the master branch,
4 # and tagging it with a new tag for the release.
5 # currently needs to be told the new release name, which is actually also gotten from
6 # the "next_version" script.  if these differ, there will be confusion for users about
7 # the right version number.  for now, look at the config file in production to get
8 # the current version, add one to the revision number, and pass major.minor.revision to
9 # this release script.
10
11 source $FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh
12
13 #hmmm: fixes--
14 #  done + need to make the version a parameter passed to here, and complain if it's not provided.
15 #  + better if we could get the version automatically, but there is a circular dependency where we want to check out the new branch by version number.
16
17 # these are the steps i take on feisty meow when i have a dev branch that is
18 # ready to merge in to the master branch as a new release.  the process
19 # includes adding the tag for the new release and such.  there are manual
20 # steps for adding the commit comments, including an introspection phase
21 # with gitk before the release commit comment is created.
22 function make_new_feisty_meow_release()
23 {
24   # snag the version number from the passed parameter.
25   local new_version="$1"; shift
26   local scriptname="$(basename $0 .sh)"
27
28   if [ -z "$new_version" ]; then
29     echo "\
30 $scriptname: this script requires a version number to use for the
31 branch name and release tag name of the new release.
32 "
33     return 1
34   fi
35
36   # jump into the top of the feisty meow codebase.
37   pushd $FEISTY_MEOW_APEX
38   # make up a release name based on the version number.
39   local new_release="release-${new_version}"
40   # make a new branch for the release based on the dev branch.
41 echo about to git checkout--hit enter
42 read line
43
44   # make sure we're working on the dev branch, since that's where our releases come from.
45   git checkout dev
46   exit_on_error checking out the dev branch
47
48   # inflate all the git branches we might need, getting all their latest.
49   rpuffer
50   exit_on_error running rpuffer on the dev branch to update it
51
52   # branch off our new release as its own entity.
53   git checkout -b $new_release dev
54   exit_on_error checking out a new branch called $new_release
55
56   # bump feisty meow version. 
57   bash ./scripts/generator/next_version.sh
58   exit_on_error bumping version for feisty meow codebase
59
60   # check in the changes in the new release branch, which now includes a revised version.
61 echo about to commit--hit enter
62 read line
63   git commit -a
64   exit_on_error committing all changes
65
66   # not sure if we really need to check in the release branch as a remote, but we like to see it in the list.
67 echo about to push new release branch--hit enter
68 read line
69   git push --set-upstream origin "$new_release"
70
71   # grab out the master branch as the active one.
72 echo about to check out master--hit enter
73 read line
74   git checkout master
75   exit_on_error checking out master branch
76
77   rpuffer
78   exit_on_error running rpuffer on master branch to update it
79
80   # merge the master branch with the new release.
81 echo about to merge--hit enter
82 read line
83   git merge --no-ff $new_release
84   exit_on_error merging in the new release in master
85   # let the committer see the most recent changes.
86   echo "=> launching gitk to show you the full set of changes;"
87   echo "=> please prepare an excellent commit comment."
88   gitk
89   exit_on_error launching gitk
90   # now make a tag for the new release, which is where we should go crazy with the detailed
91   # and useful comments for what has changed in this release, gathered from the gitk that
92   # we just launched.  this should include all of the work on the development branch since
93   # the last release...
94 echo about to TAG--hit enter
95 read line
96   git tag -a $new_version
97   exit_on_error tagging new version as $new_version
98   # commit the full set of changes for the master branch now, including the tags.
99 echo about to commit master branch with all those changes--hit enter
100 read line
101   rcheckin .
102   exit_on_error checking in the changes in master branch
103   # switch back to the dev branch.
104 echo switching to dev branch--hit enter
105 read line
106   git checkout dev
107   exit_on_error checking the dev branch out again
108   # merge in the latest changes from master, which should only be the revised version really.
109 echo merging in from release branch to dev--hit enter
110 read line
111   git merge --no-ff $new_release
112   exit_on_error merging the release changes into the dev branch
113 echo pushing merged dev branch up
114   git push 
115   exit_on_error pushing merged dev branch up
116
117   # done with the serious actions.
118   echo -e "\ncompleted the release of version $new_version\n"
119
120   # back to where we started.
121   popd
122 }
123
124 make_new_feisty_meow_release "$1"
125