Merge pull request #1573 from jim-parry/lessons-learned

Lessons learned

admin/docbot

@@ -1,8 +1,14 @@
 #!/bin/bash
 
-# Rebuild and deploy CodeIgniter4 user guide
+# Rebuild and deploy CodeIgniter4 under-development user guide
+#
+# This is a quick way to test user guide changes, and if they
+# look good, to push them to the gh-pages branch of the
+# development repository.
+#
+# This is not meant for updating the "stable" user guide.
 
-. config
+UPSTREAM=https://github.com/bcit-ci/CodeIgniter4.git
 
 # Prepare the nested repo clone folder
 cd user_guide_src

admin/next.rst

@@ -0,0 +1,14 @@
+Version |version|
+====================================================
+
+Release Date: Not released
+
+**Next alpha release of CodeIgniter4**
+
+
+The list of changed files follows, with PR numbers shown.
+
+
+PRs merged:
+-----------
+

admin/release

@@ -56,12 +56,14 @@ sed -i "/Release Date/s/Not Released/$(date +'%B %d, %Y')/" user_guide_src/sourc
 sed -i "/|version|/s/|version|/${RELEASE}/" user_guide_src/source/changelogs/index.rst
 
 # version & date in user_guide_src/source/next.rst
-sed -i "/|release|/s/|.*|/${RELEASE}/" user_guide_src/source/changelogs/next.rst
 sed -i "/Release Date/s/Not Released/$(date +'%B %d, %Y')/" user_guide_src/source/changelogs/next.rst
 sed -i "/|version|/s/|version|/${RELEASE}/" user_guide_src/source/changelogs/next.rst
 
 # establish version-specific changelog
-mv user_guide_src/source/changelogs/next.rst user_guide_src/source/changelogs/${RELEASE}.rst
+sed -i "|changelogs/next|s|changeslog/next|changelogs/v{$RELEASE}| user_guide_src/source/changelogs/index.rst
+mv user_guide_src/source/changelogs/next.rst user_guide_src/source/changelogs/v${RELEASE}.rst
+touch user_guide_src/source/changelogs/next.rst
+cp admin/next.rst user_guide_src/source/changelogs/next.rst
 
 #---------------------------------------------------
 # Setup the distribution folders
@@ -91,6 +93,15 @@ setup_repo framework
 setup_repo userguide
 setup_repo appstarter
 
+#---------------------------------------------------
+# Housekeeping - make sure writable is flushed of test files
+# at least, test files that crop up on my system :-/
+rm -f writable/cache/H*
+rm -f writable/cache/d*
+rm -f writable/cache/s*
+rm -f writable/debugbar/debug*
+rm -f writable/logs/log*
+
 #---------------------------------------------------
 # Generate the user guide
 echo -e "${BOLD}Generate the user guide${NORMAL}"
@@ -101,6 +112,7 @@ cd user_guide_src
 rm -rf build/*
 echo -e "${BOLD}... HTML version${NORMAL}"
 make html
+touch build/html/.nojekyll
 echo -e "${BOLD}... epub version${NORMAL}"
 make epub
 
@@ -119,6 +131,11 @@ sed -i "11 G" $file
 sed -i "12 a :doc:\`See all the changes. </changelogs/next>\`" $file
 sed -i "13 G" $file
 
+#---------------------------------------------------
+echo -e "${BOLD}Commit the release branch${NORMAL}"
+git add .
+git commit -S -m "Release ${RELEASE}"
+
 #---------------------------------------------------
 # Build the distributables
 

admin/release-deploy

@@ -22,17 +22,14 @@ git push ${CI_ORG}/CodeIgniter4 develop
 echo -e "${BOLD}Pushing to the user guide repository${NORMAL}"
 cd ${CI_DIR}/dist/userguide
 git push origin master
-git push ${CI_ORG}/userguide master
 
 echo -e "${BOLD}Pushing to the framework repository${NORMAL}"
 cd ${CI_DIR}/dist/framework
 git push origin master
-git push ${CI_ORG}/framework master
 
 echo -e "${BOLD}Pushing to the app starter repository${NORMAL}"
 cd ${CI_DIR}/dist/appstarter
 git push origin master
-git push ${CI_ORG}/appstarter master
 
 cd ${CI_DIR}
 

admin/release-notes.bb

@@ -1,3 +1,5 @@
+CAUTION: THIS FILE IS A MIX OF BBCODE & MARKDOWN... NEEDS PROOFING
+
 CodeIgniter-4.0.0-alpha.1 launches today, after a lengthy build-up :)
 
 Huge shoutout to Lonnie Ezell for all of his hard work getting the vision

admin/starter/composer.json

@@ -6,7 +6,7 @@
     "license": "MIT",
     "require": {
         "php": ">=7.1",
-        "codeigniter4/framework": "^4",
+        "codeigniter4/framework": "^4@alpha",
          "ext-curl": "*",
         "ext-intl": "*",
         "kint-php/kint": "^2.1",

user_guide_src/source/changelogs/index.rst

@@ -31,7 +31,7 @@ Release Date: November 30, 2018
 - We welcome Natan Felles, from Brazil, to the code developer team.
   He has proven to be passionate, dedicated and thorough :)
 
-:doc:`See all the changes. </changelogs/next>`
+:doc:`See all the changes. </changelogs/v4.0.0-alpha.3>`
 
 
 Version 4.0.0-alpha.2

user_guide_src/source/changelogs/next.rst

@@ -0,0 +1,14 @@
+Version |version|
+====================================================
+
+Release Date: Not released
+
+**Next alpha release of CodeIgniter4**
+
+
+The list of changed files follows, with PR numbers shown.
+
+
+PRs merged:
+-----------
+