First crack at updated admin scripts

Author: jim-parry

admin/README.md

@@ -2,7 +2,7 @@
 
 This folder contains tools or docs useful for project maintainers.
 
-##Repositories Organization, inside https://github.com/codeigniter4
+##Repositories inside https://github.com/codeigniter4
 
 -   **CodeIgniter4** is the main development repository.  
     It supports issues and pull requests, and has a rule to enforce GPG-signed commits.  
@@ -45,6 +45,7 @@ This folder contains tools or docs useful for project maintainers.
 
 ##Maintainer Scripts
 
+-   **config** holds variables used for the maintainer & release building
 -   **docbot** re-builds the user guide from the RST source for it,
     and optionally deploys it to the `gh-pages` branch of the main
     repository (if the user running it has maintainer rights on that repo).  
@@ -59,7 +60,7 @@ scripts used by the release manager:
     This includes updating version dependencies or constants,
     generating version(s) of the user guide; and possibly
     moving or ignoring stuff, distinguishing release from development.
-    If successful, it will leave a `releasing` file, with the version number
+    If successful, it will update the `config` file, with the version number
     in it.
 -   **release** builds release branches for the derived repositories
     (framework, appstarter and userguide).  

admin/config

@@ -0,0 +1,12 @@
+
+# Variables used for maintainers & release building
+
+CI_ORG=https://github.com/codeigniter4/
+
+BOLD='\033[1m'
+NORMAL='\033[0m'
+COLOR='\033[1;31m'
+ERROR='\033[0;31m'
+
+# If RELEASE is set to something below, then we are part-way through the workflow
+RELEASE=

admin/docbot

@@ -2,7 +2,7 @@
 
 # Rebuild and deploy CodeIgniter4 user guide
 
-UPSTREAM=https://github.com/codeigniter4/CodeIgniter4.git
+. config
 
 # Prepare the nested repo clone folder
 cd user_guide_src

admin/post_release

@@ -1,9 +1,8 @@
 #!/bin/bash
-#######################DO NOT USE YET########################
 
 ## Cleanup after a framework release
 
-UPSTREAM=https://github.com/codeigniter4/CodeIgniter4.git
+UPSTREAM=${CI_ORG}CodeIgniter4.git
 version=4
 qualifier=
 

admin/pre-release

@@ -1,26 +1,27 @@
 #!/bin/bash
-#######################DO NOT USE YET########################
 
-## Build a framework release branch
+## Build framework release branch & distributables
 
 #---------------------------------------------------
 # Setup variables
 
-UPSTREAM=https://github.com/codeigniter4/CodeIgniter4.git
+. admin/config
+
+#---------------------------------------------------
+# Sanity check - are we underway already?
+if [ -n "$RELEASE" ]; then
+    echo -e "${BOLD}${ERROR}A release build is already underway${NORMAL}"
+    exit 1
+fi
+
 action=test
 version=4
 qualifier=
 
 branch=release-
 releasable='application docs public system writable README.md composer.json contributing.md env license.txt spark'
-release_empty='tests tests/_support'
 which=release
 
-BOLD='\033[1m'
-NORMAL='\033[0m'
-COLOR='\033[1;31m'
-ERROR='\033[0;31m'
-
 echo -e "${BOLD}${COLOR}CodeIgniter4 release builder${NORMAL}"
 echo '----------------------------'
 
@@ -29,7 +30,7 @@ echo '----------------------------'
 echo -e "${BOLD}Checking arguments...${NORMAL}"
 
 if [ $# -lt 1 ]; then
-    echo -e "${BOLD}Usage: admin/release version# pre-release-qualifier${NORMAL}"
+    echo -e "${BOLD}Usage: admin/pre-release version# pre-release-qualifier${NORMAL}"
     exit 1
 fi
 
@@ -39,7 +40,8 @@ if [ $# -gt 1 ]; then
     qualifier="-${2}"
     which='pre-release'
 fi
-branch="release-$version$qualifier"
+RELEASE=$version$qualifier
+branch="release-$RELEASE"
 
 #---------------------------------------------------
 # Create the release branch
@@ -57,39 +59,51 @@ echo -e "${BOLD}Updating version dependencies${NORMAL}"
 function check_unique {
     count=`grep -c '$1' < $2 | wc -l`
     if [ $count -ne 1 ]; then
-        echo -e "${BOLD}${COLOR}$2 has ${count} occurences of '$1'${NORMAL}"
+        echo -e "${BOLD}${COLOR}$2 has ${count} occurrences of '$1'${NORMAL}"
         exit 1
     fi
 }
 
 # Make sure there is only one line to affect in each file
 check_unique "const CI_VERSION" 'system/CodeIgniter.php'
 check_unique "release =" 'user_guide_src/source/conf.py'
-check_unique "|release|" 'user_guide_src/source/changelog.rst'
-check_unique "Release Date.*Not Released" 'user_guide_src/source/changelog.rst'
+check_unique "|release|" 'user_guide_src/source/changelogs/index.rst'
+check_unique "Release Date.*Not Released" 'user_guide_src/source/changelogs/index.rst'
 
 # CI_VERSION definition in system/CodeIgniter.php
-sed -i "/const CI_VERSION/s/'.*'/'${version}${qualifier}'/" system/CodeIgniter.php
+sed -i "/const CI_VERSION/s/'.*'/'${RELEASE}'/" system/CodeIgniter.php
 
 # release substitution variable in user_guide_src/source/conf.py
-sed -i "/release =/s/'.*'/'${version}${qualifier}'/" user_guide_src/source/conf.py
+sed -i "/release =/s/'.*'/'${RELEASE}'/" user_guide_src/source/conf.py
 
 # version & date in user_guide_src/source/changelog.rst
-sed -i "/|release|/s/|.*|/${version}${qualifier}/" user_guide_src/source/changelog.rst
-sed -i "/Release Date/s/Not Released/$(date +'%B %d, %Y')/" user_guide_src/source/changelog.rst
+sed -i "/|release|/s/|.*|/${RELEASE}/" user_guide_src/source/changelogs/index.rst
+sed -i "/Release Date/s/Not Released/$(date +'%B %d, %Y')/" user_guide_src/source/changelogs/index.rst
+
+# establish version-specific changelog
+mv user_guide_src/source/changelogs/next.rst user_guide_src/source/changelogs/${RELEASE}.rst
+# start new changelog for next version
 
 #---------------------------------------------------
 # Setup the distribution folders
+echo -e "${BOLD}Building repo distributions${NORMAL}"
+
+function setup_repo {
+    mkdir dist/$1
+    cd dist/$1
+    git init
+    git remote add origin ${CI_ORG}/$1
+    git fetch
+}
 
 if [ -d dist ]; then
     rm -rf dist/
 fi
 mkdir dist
 
-if [ -d build ]; then
-    rm -rf build/
-fi
-mkdir build
+setup_repo framework
+setup_repo docs
+setup_repo app-starter
 
 #---------------------------------------------------
 # Generate the user guide
@@ -104,32 +118,34 @@ make epub
 
 cd ..
 
-mv user_guide_src/build/html build/docs
+cp -rf user_guide_src/build/html dist/docs
+mv user_guide_src/built/html dist/framework/docs
+
+cd dist/docs
+git checkout gh-pages
+cp -r ../../docs .
 
 #---------------------------------------------------
 # And finally, get ready for merging
 git add .
-git commit -m "Release ${version}${qualifier}"
+git commit -m "Release ${RELEASE}"
 
 #---------------------------------------------------
 # Hide stuff from the release bundle
 echo -e "${BOLD}Build the distributables${NORMAL}"
 
-for f in $releasable; do
-    cp -r $f build/
-done
-for f in $release_empty; do
-    mkdir build/$f
-done
-
 # add the docs
-mv user_guide_src/build/epub/CodeIgniter4.epub dist/CodeIgniter-${version}${qualifier}.epub
+mv user_guide_src/build/epub/CodeIgniter4.epub dist/CodeIgniter-${BRANCH}.epub
 
 cd build
-zip -r  ../dist/v${version}${qualifier}.zip *
-tar -zcf  ../dist/v${version}${qualifier}.tar.gz *
+zip -r  ../dist/v${RELEASE}.zip *
+tar -zcf  ../dist/v${RELEASE}.tar.gz *
+
+#---------------------------------------------------
+# Save the in-progress branch designation for following steps
+sed -i "/RELEASE=/s/=.*/=${RELEASE}/" admin/config
 
 #---------------------------------------------------
 # Done for now
 echo -e "${BOLD}Your $branch branch is ready to inspect.${NORMAL}"
-echo -e "${BOLD}Follow the directions in release.md to continue.${NORMAL}"
+echo -e "${BOLD}Follow the directions in workflow.md to continue.${NORMAL}"

admin/release

@@ -1,12 +1,21 @@
 #!/bin/bash
-#######################DO NOT USE YET########################
 
 ## Build the distributable repo branches
 
+. admin/config
+
+#---------------------------------------------------
+# Sanity check - are we underway already?
+if [ "$BRANCH" ]; then
+    echo -e "${BOLD}${ERROR}No release build is underway${NORMAL}"
+    exit 1
+fi
+
+
 #---------------------------------------------------
 # Setup variables
 
-UPSTREAM=https://github.comcodeigniter4/CodeIgniter4.git
+UPSTREAM=${CI_ORG}CodeIgniter4.git
 action=test
 version=4
 qualifier=

admin/workflow.md

@@ -1,18 +1,25 @@
 # Workflow
 
-The repo has two branches of interest: "master" (stable) and "develop" (in progress).
+The main repo has two branches of interest: "master" (stable) and "develop" (in progress).
 There might be other feature branches, but they are not relevant to this process.
 
 Once "develop" is ready for a new release, the general workflow is to
 
+pre-release...
 - create a "release" branch from develop
 - update version dependencies or constants
 - generate version(s) of the user guide
 - move or ignore stuff, distinguishing release from development
 - test that all is as it should be
+
+release...
 - merge the release branch into "master"
-- **manually** create the release & tag on github, based on master
-- put everything back where it should be for development
+- update the distribution repos
+- **manually** create the releases & tag them on github, based on master
+
+post-release...
+- eliminate the build & dist folders used above
+- setup substitution variables for the next release
 - merge the post-release branch into "master"
 - merge the post-release branch into "develop"
 - **manually** delete the release branches in the repo
@@ -30,21 +37,13 @@ Visually:
     post-release -> master
     post->release  -> develop
 
-The `release` bash script does the first six workflow steps,
-and the `post-release` script does the other three between
-the manual steps.
-
-For now, everything past the release branch build will be done
-manually, until the condidence level is high enough to
-automate some/all of those steps.
-
 ## Assumptions
 
 You (a maintainer) have forked the main CodeIgniter4 repo,
 and the git alias `origin`, in your local clone, refers to your fork. 
-The script creates an additional alias, `upstream`, which refers to the 
-main repo. This separation keeps the release branch isolated
-for any testing you want to do.
+The `config` script defines an additional alias, `CI_ORG`, which refers to the 
+CodeIgniter 4 organization on github. 
+This separation keeps the release branch isolated for any testing you want to do.
 
 The `develop` branch of the main repo should be "clean", and ready for
 a release. This means that the changelog and upgrading instructions
@@ -58,9 +57,9 @@ as part of a bug fix minor release.
 
 Inside a shell prompt, in the project root:
 
-    `admin/release version [qualifier]`
+    `admin/pre-release version [qualifier]`
 
-Nothing is pushed to the repo. at this point -
+Nothing is pushed to the repo at this point -
 the results are left inside
 the release branch in your local clone.
 
@@ -71,25 +70,27 @@ The "qualifier" argument is a suffix to add to the version
 for a pre-release, e.g. `beta.2` or `rc.41`.
 
 Examples:
-- `admin/release 4.0.0 alpha.1` would prepare the "4.0.0-alpha.1" pre-release PR
-- `admin/release 4.0.0` would prepare the "4.0.0" release PR
-- `admin/release peanut butter banana` would complain and tell you to read these directions
+- `admin/pre-release 4.0.0 alpha.1` would prepare the "4.0.0-alpha.1" pre-release PR
+- `admin/pre-release 4.0.0` would prepare the "4.0.0" release PR
+- `admin/pre-release peanut butter banana` would complain and tell you to read these directions
+
+Once you have vetted the `dist` folder inside your local repo, you
+can merge & push everything with
+
+    `admin/release`
 
-Complete the next few steps of the release manually:
-- merge the release branch to "master"
-- push that to the main repo
-- on github.com, create an appropriate release (or pre-release)
+On github.com, create an appropriate release (or pre-release),
+with any optional files from the root of `dist`.
 
-Once the release branch has been vetted, and you have
-completed the manual steps, clean up with:
+Once the github releases are done, clean up with:
 
-    `admin/post_release version [qualifier]`
+    `admin/post_release`
 
 ## Release notes
 
 On launch of a new release, a release notes post should be made in the
 announcements subforum. The planned text for it (so it can be previewed
-by admins) is in `admin/release_notes`.
+by admins) is in `admin/release_notes.bb`.
 
 ## Audience