Merge pull request #83 from BitCurator/UPDATE/version

Updated VERSION and minor doc fixes

BUILD.md

@@ -3,6 +3,7 @@
 These instructions are intended for maintainers generating new releases of the BitCurator environment. **For instructions on installing BitCurator, see the main README**.
 
 #### Step 1 - Preparing the work environment
+
 In the .ci directory of the repo, there is a script called `tag-and-sign.sh`. This script must be updated to contain the proper `VERSION_FILE` value, and the URLs throughout must point to the appropriate repo.
 
 Additionally, throughout you will see that `gpg --armor` is used to sign the release. After the `-u` variable, you should place your 8-character public signing key value.
@@ -12,20 +13,34 @@ The remainder of the scripts in this directory are all for testing salt-states,
 Finally, you will need to add your GitHub Access Token to the environment. The easiest way to do this would be to put it in your `~/.bashrc` file and then `source ~/.bashrc`. However, you can customize the `tag-and-sign.sh` script as you wish if you decide you'd rather pass it manually as an argument.
 Or you can just `export GITHUB_ACCESS_TOKEN=<token>` then unset it after you're done.
 
-#### Step 2 - Generating the release
-Once you've made the changes you require, to your salt-states, edit the `VERSION` file (as you indicated with the variable `VERSION_FILE` in Step 1) to reflect the new version.
+#### Step 2a - Preparing to generate the release
+
+Once you've made the changes you require to your salt-states, edit the `VERSION` file (as you indicated with the variable `VERSION_FILE` in Step 1) to reflect the new version.
+
 Then push your changes:
+
 ```bash
 $ git add -A
 $ git commit -m '<message here>'
 $ git push
 ```
+
+Next follow Step 2a OR Step 2b.
+
+#### Step 2a - Generating the release (Cast + bitcurator-cli compatibility)
+
+Once your push is complete, go to the root of your repo folder and run:
+`$ ./.ci/cast-and-sign.sh <version>` where `<version>` is the version number you added in the `VERSION` file, and wish to create a tag for.
+
+#### Step 2b - Generating the release (Legacy, bitcurator-cli compatibility only)
+
 Once your push is complete, go to the root of your repo folder and run:
 `$ ./.ci/tag-and-sign.sh <version>` where `<version>` is the version number you added in the `VERSION` file, and wish to create a tag for.
 
 Once successful, the release will be available on your GitHub repo.
 
 #### Step 3 - Profit
+
 If done properly, you should only ever have to do Step 2 from here-on-in, unless you change your dev environment frequently.
 
 ## Building Releases of the BitCurator Environment

README.md

@@ -25,7 +25,7 @@ When installation is completed, reboot, log in, and open a terminal.
 
 **1. Prepare your environment**
 
-To ensure you have all of the tools, and updates necessary for the BitCurator environment to succeed, you should update the local `apt` repository and install the necessary tools:
+To ensure you have all tools and updates necessary for the BitCurator environment to install correctly, update the local `apt` repository and install some required tools:
 
 ```shell
 sudo apt-get update && sudo apt-get upgrade -y
@@ -89,7 +89,9 @@ After reboot, log in using the credentials your provided earlier. (If you select
 
 ## Updating and Upgrading
 
-Once BitCurator is installed, you may install additional software and update the Ubuntu OS as normal, either from the Software Center or with `sudo apt-get update && sudo apt-get upgrade` on the command line. We recommend that you decline LTS-to-LTS upgrades (for example, Ubuntu 22.04LTS to 24.04LTS) and perform a clean install when moving to a new LTS.
+Once BitCurator is installed, you may install additional software and update the Ubuntu OS as normal, either from the Software Center or with `sudo apt-get update && sudo apt-get upgrade` on the command line. 
+
+We recommend that you decline LTS-to-LTS upgrades (for example, a pop-up notice in Ubuntu 22.04LTS announcing that 24.04LTS is available) and perform a clean install when moving to a new LTS.
 
 The BitCurator CLI tool may also be used to selectively upgrade those packages specifically associated with the BitCurator environment, and to upgrade the BitCurator verion. To see all options for the BitCurator CLI, type the following in a terminal:
 

bitcurator/VERSION

@@ -1 +1 @@
-5.0.0-rc11
+5.0.0-rc12