Added version release changes.

Out of all permissive licenses, this provides the clearest terms and
conditions.

[Details](https://choosealicense.com/licenses/apache-2.0).

[ci skip]

.github/ISSUE_TEMPLATE.md

@@ -1,16 +1,11 @@
-## Expected Behavior
+## Overview
-<!-- Required. Describe, in detail, the behavior experienced. -->
+<!-- Required. Describe, in detail, the behavior experienced and what is desired. -->
-
-## Actual Behavior
-<!-- Required. Describe, in detail, what should be the correct behavior. -->
 
 ## Steps to Recreate
-<!-- Required. List the exact steps to the reproduce errant behavior. -->
+<!-- Optional. List exact steps (numbered list) to reproduce errant behavior. Delete if unused. -->
 
-0.
+## Screenshots/Screencasts
+<!-- Optional. Attach screenshot/screencast(s) that demo the behavior. Delete if unused. -->
 
 ## Environment
 <!-- Optional. What is your operating system, software version(s), etc. Delete if unused. -->
-
-## Screenshots/Screencasts
-<!-- Optional. Attach screenshots/screencasts that demo the behavior. Delete if unused. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,10 +2,10 @@
 <!-- Required. Why is this important/necessary? -->
 
 ## Details
-<!-- Optional. List the key features/highlights as bullet points. -->
+<!-- Optional. List the key features/highlights as bullet points. Delete if unused. -->
 
 ## Notes
 <!-- Optional. List additional notes/references as bullet points. Delete if unused. -->
 
 ## Screenshots/Screencasts
-<!-- Optional. Provide image/video support. Delete if unused. -->
+<!-- Optional. Provide supporting image/video. Delete if unused. -->

.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

.ruby-version

@@ -0,0 +1 @@
+2.5.0

CHANGES.md

@@ -1,3 +1,35 @@
+# v4.0.0 (2018-01-01)
+
+- Added Gemfile.lock to .gitignore.
+- Updated to Apache 2.0 license.
+- Updated to Ruby 2.4.3.
+- Updated to Ruby 2.5.0.
+
+# v3.1.0 (2017-11-26)
+
+- Updated Gemfile.lock file.
+- Updated boot disk documenation to mention APFS.
+- Updated to Bundler 1.16.0.
+- Updated to Git Cop 1.7.0.
+- Updated to Rake 12.3.0.
+- Updated to Rubocop 0.51.0.
+
+# v3.0.0 (2017-10-01)
+
+- Fixed table of contents.
+- Updated boot disk creation to use macOS High Sierra.
+- Updated gem dependencies.
+- Updated to Git Cop 1.6.0.
+- Updated to Ruby 2.4.2.
+
+# v2.2.0 (2017-07-16)
+
+- Added Git Cop support.
+- Updated CONTRIBUTING documentation.
+- Updated GitHub templates.
+- Updated README headers.
+- Updated gem dependencies.
+
 # v2.1.0 (2017-04-29)
 
 - Fixed Java SE Development Kit install.

CONTRIBUTING.md

@@ -1,27 +1,22 @@
-# Overview
+# Contributing
 
 Thanks for taking an interest in this open source project. Your support and involvement is greatly
-appreciated. The following details what you need to know in order to contribute.
+appreciated. The following sections detail what you need to know in order to contribute.
 
-# Requirements
+## Code
-
-Read through the [Programming Style
-Guides](https://github.com/bkuhlmann/style_guides/tree/master/programming).
-
-# Contributing Code
 
 0. Read the project README before starting.
-0. Fork the `master` branch of the repository.
+0. Fork the `master` branch of this repository and clone the fork locally.
-0. Ensure there are no setup, usage, and/or test issues (see README for details).
+0. Ensure there are no setup, usage, and/or test issues.
 0. Add tests for new functionality and ensure they pass.
-0. Submit a pull request and follow the instructions it provides.
+0. Submit a pull request, follow the instructions it provides, and ensure the build passes.
 
-# Submitting Issues
+## Issues
 
-0. Submit an issue via the GitHub Issues tab (assuming one does not already exist).
+0. Submit an issue via the GitHub Issues tab (assuming one does not
-0. Follow the instructions provided within the GitHub issue template.
+   already exist) and follow the instructions it provides.
 
-# Feedback
+## Feedback
 
-Expect a response within one to three business days.
+- Expect a response within one to three business days.
-Changes, alternatives, and/or improvements might be suggested upon review.
+- Changes, alternatives, and/or improvements might be suggested upon review.

Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "rake", "~> 12.0"
+gem "git-cop", "~> 2.0"

LICENSE.md

@@ -1,20 +1,163 @@
-Copyright (c) 2016 [Alchemists](https://www.alchemists.io).
+# Apache License
 
-Permission is hereby granted, free of charge, to any person obtaining
+Version 2.0, January 2004
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
 
-The above copyright notice and this permission notice shall be
+http://www.apache.org/licenses
-included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+## 1. Definitions
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+Sections 1 through 9 of this document.
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is
+granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are
+controlled by, or are under common control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this
+License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to
+software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a
+Source form, including but not limited to compiled object code, generated documentation, and
+conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the
+License, as indicated by a copyright notice that is included in or attached to the work (an example
+is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or
+derived from) the Work and for which the editorial revisions, annotations, elaborations, or other
+modifications represent, as a whole, an original work of authorship. For the purposes of this
+License, Derivative Works shall not include works that remain separable from, or merely link (or
+bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any
+modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted
+to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity
+authorized to submit on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent to the Licensor or
+its representatives, including but not limited to communication on electronic mailing lists, source
+code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor
+for the purpose of discussing and improving the Work, but excluding communication that is
+conspicuously marked or otherwise designated in writing by the copyright owner as "Not a
+Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
+Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+## 2. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a
+perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
+distribute the Work and such Derivative Works in Source or Object form.
+
+## 3. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a
+perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer
+the Work, where such license applies only to those patent claims licensable by such Contributor that
+are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You institute patent litigation
+against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or
+a Contribution incorporated within the Work constitutes direct or contributory patent infringement,
+then any patent licenses granted to You under this License for that Work shall terminate as of the
+date such litigation is filed.
+
+## 4. Redistribution
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
+or without modifications, and in Source or Object form, provided that You meet the following
+conditions:
+
+1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+2. You must cause any modified files to carry prominent notices stating that You changed the
+   files; and
+
+3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
+   patent, trademark, and attribution notices from the Source form of the Work, excluding those
+   notices that do not pertain to any part of the Derivative Works; and
+
+4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative
+   Works that You distribute must include a readable copy of the attribution notices contained
+   within such NOTICE file, excluding those notices that do not pertain to any part of the
+   Derivative Works, in at least one of the following places: within a NOTICE text file
+   distributed as part of the Derivative Works; within the Source form or documentation, if
+   provided along with the Derivative Works; or, within a display generated by the Derivative
+   Works, if and wherever such third-party notices normally appear. The contents of the NOTICE
+   file are for informational purposes only and do not modify the License. You may add Your own
+   attribution notices within Derivative Works that You distribute, alongside or as an addendum to
+   the NOTICE text from the Work, provided that such additional attribution notices cannot be
+   construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or
+different license terms and conditions for use, reproduction, or distribution of Your modifications,
+or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
+the Work otherwise complies with the conditions stated in this License.
+
+## 5. Submission of Contributions
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
+Work by You to the Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed with Licensor regarding such
+Contributions.
+
+## 6. Trademarks
+
+This License does not grant permission to use the trade names, trademarks, service marks, or product
+names of the Licensor, except as required for reasonable and customary use in describing the origin
+of the Work and reproducing the content of the NOTICE file.
+
+## 7. Disclaimer of Warranty
+
+Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties or conditions of
+TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely
+responsible for determining the appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+## 8. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including negligence), contract, or
+otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
+agreed to in writing, shall any Contributor be liable to You for damages, including any direct,
+indirect, special, incidental, or consequential damages of any character arising as a result of this
+License or out of the use or inability to use the Work (including but not limited to damages for
+loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
+damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+## 9. Accepting Warranty or Additional Liability
+
+While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
+for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
+consistent with this License. However, in accepting such obligations, You may act only on Your own
+behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or
+claims asserted against, such Contributor by reason of your accepting any such warranty or
+additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2016 [Alchemists](https://www.alchemists.io).
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
+compliance with the License. You may obtain a [copy](http://www.apache.org/licenses/LICENSE-2.0) of
+the License.
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is
+distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied. See the License for the specific language governing permissions and limitations under the
+License.

README.md

@@ -1,5 +1,6 @@
 # macOS
 
+[![Circle CI Status](https://circleci.com/gh/bkuhlmann/mac_os.svg?style=svg)](https://circleci.com/gh/bkuhlmann/mac_os)
 [![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
 
 Shell scripts for automated macOS machine setup.
@@ -13,30 +14,30 @@ the two projects are meant to be used:
 
 - **macOS** (this project) - Foundation and framework for building customizated macOS machine
   setups.
-- **[macOS Config](https://github.com/bkuhlmann/mac_os-config)** - The layer on top of this *macOS*
+- **[macOS Configuration](https://github.com/bkuhlmann/mac_os-config)** - The layer on top of this
-  project which defines a custom machine setup and base implementation. The project is meant to be
+  *macOS* project which defines a custom machine setup and base implementation. The project is meant
-  forked for as many custom machine setups as needed.
+  to be forked for as many custom machine setups as needed.
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
-# Table of Contents
+## Table of Contents
 
-- [Features](#features)
+  - [Features](#features)
-- [Screencast](#screencast)
+  - [Screencast](#screencast)
-- [Requirements](#requirements)
+  - [Requirements](#requirements)
-- [Setup](#setup)
+  - [Setup](#setup)
-- [Usage](#usage)
+  - [Usage](#usage)
-  - [Customization](#customization)
+    - [Customization](#customization)
-- [Versioning](#versioning)
+  - [Versioning](#versioning)
-- [Code of Conduct](#code-of-conduct)
+  - [Code of Conduct](#code-of-conduct)
-- [Contributions](#contributions)
+  - [Contributions](#contributions)
-- [License](#license)
+  - [License](#license)
-- [History](#history)
+  - [History](#history)
-- [Credits](#credits)
+  - [Credits](#credits)
 
 <!-- Tocer[finish]: Auto-generated, don't remove. -->
 
-# Features
+## Features
 
 - Provides a command line interface, written in Bash with no additional dependencies, for
   installation and management of a macOS machine.
@@ -55,16 +56,16 @@ the two projects are meant to be used:
 - Sets up and configures installed software for use.
 - Supports restoration of machine backups.
 
-# Screencast
+## Screencast
 
 [![asciicast](https://asciinema.org/a/88971.png)](https://asciinema.org/a/88971)
 
-# Requirements
+## Requirements
 
-0. [macOS Sierra](https://www.apple.com/macos) (with latest software updates applied)
+0. [macOS High Sierra](https://www.apple.com/macos) (with latest software updates applied)
 0. [Xcode](https://developer.apple.com/xcode) (with accepted license agreement)
 
-# Setup
+## Setup
 
 Open a terminal window and execute one of the following setup sequences depending on your version
 preference:
@@ -73,14 +74,14 @@ Current Version (stable):
 
     git clone https://github.com/bkuhlmann/mac_os.git
     cd mac_os
-    git checkout v2.1.0
+    git checkout v4.0.0
 
 Master Version (unstable):
 
     git clone https://github.com/bkuhlmann/mac_os.git
     cd mac_os
 
-# Usage
+## Usage
 
 Run the following script:
 
@@ -126,7 +127,7 @@ been loaded.
 It is recommended that the `mac_os` project directory not be deleted and kept on the local machine
 in order to manage installed software and benefit from future upgrades.
 
-## Customization
+### Customization
 
 All executable scripts can be found in the `bin` folder:
 
@@ -157,7 +158,7 @@ project is built upon the functions found in the `lib` folder. See the
 
   - `lib/settings.sh`: Defines global settings for software applications, extensions, etc.
 
-# Versioning
+## Versioning
 
 Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 
@@ -165,26 +166,26 @@ Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 - Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
 - Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
 
-# Code of Conduct
+## Code of Conduct
 
 Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
 participating in this project you agree to abide by its terms.
 
-# Contributions
+## Contributions
 
 Read [CONTRIBUTING](CONTRIBUTING.md) for details.
 
-# License
+## License
 
 Copyright (c) 2016 [Alchemists](https://www.alchemists.io).
 Read [LICENSE](LICENSE.md) for details.
 
-# History
+## History
 
 Read [CHANGES](CHANGES.md) for details.
 Built with [Bashsmith](https://github.com/bkuhlmann/bashsmith).
 
-# Credits
+## Credits
 
 Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
 [Alchemists](https://www.alchemists.io).

Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+begin
+  require "git/cop/rake/setup"
+rescue LoadError => error
+  puts error.message
+end
+
+task default: :git_cop

bin/create_boot_disk

@@ -12,7 +12,7 @@ printf "  1. Insert the USB boot disk into the machine to be upgraded.\n"
 printf "  2. Reboot the machine.\n"
 printf "  3. Hold down the OPTION key before the Apple logo appears.\n"
 printf "  4. Select the USB boot disk from the menu.\n"
-printf "  5. Format the machine's internal drive using Disk Utility.\n"
+printf "  5. Format the machine's internal drive using Disk Utility (choose APFS).\n"
 printf "  6. Install the new operating system.\n"
 printf "\nmacOS Reinstall:\n"
 printf "  1. Click the Apple icon from the operating system main menu.\n"

circle.yml

@@ -0,0 +1,7 @@
+dependencies:
+  pre:
+    - gem update --system
+    - gem update bundler
+test:
+  override:
+    - bundle exec rake

lib/settings.sh

@@ -11,9 +11,9 @@ set -o pipefail
 IFS=$'\n\t'
 
 # Globals
-export MAC_OS_BOOT_DISK_CREATOR="/Applications/Install macOS Sierra.app/Contents/Resources/createinstallmedia"
+export MAC_OS_BOOT_DISK_CREATOR="/Applications/Install macOS High Sierra.app/Contents/Resources/createinstallmedia"
 export MAC_OS_BOOT_DISK_PATH="/Volumes/Untitled"
-export MAC_OS_INSTALLER_PATH="/Applications/Install macOS Sierra.app"
+export MAC_OS_INSTALLER_PATH="/Applications/Install macOS High Sierra.app"
 export MAC_OS_WORK_PATH=/tmp/downloads
 export MAC_OS_CONFIG_PATH="../mac_os-config"