Compare commits

...

95 Commits
2.2.0 ... 8.1.0

Author SHA1 Message Date
Brooke Kuhlmann
75e9401ff3 Added version release notes 2020-04-01 10:40:58 -06:00
Brooke Kuhlmann
413d4a65fe Updated to Ruby 2.7.1
Addresses the following security issues:

- CVE-2020-16255: Unsafe Object Creation Vulnerability in JSON
  (Additional fix)
- CVE-2020-10933: Heap exposure vulnerability in the socket library

[Details](https://chl.li/ljREu).
2020-03-31 13:22:33 -06:00
Brooke Kuhlmann
5dbed92f89 Updated README screencast to use larger image
Leverages a larger image so the terminal is easier to read at first
glance.
2020-03-29 08:12:09 -06:00
Brooke Kuhlmann
97893843de Updated documentation to ASCII Doc format
Provides enhanced capabilities and customization beyond what Markdown
provides.
2020-03-25 19:04:44 -06:00
Brooke Kuhlmann
9a37f06826 Updated to Code of Conduct 2.0.0
Includes improved enforcement guidelines. Format has been switched to
ASCII Doc from Markdown in order to leverage enhanced documentation
capabilities.
2020-03-20 11:30:46 -06:00
Brooke Kuhlmann
50b9edd7f7 Removed README images
These are now hosted on https://www.alchemists.io so binaries don't
pollute the Git repository. This is the first step of many to migrate
more project information over to https://www.alchemists.io.
2020-03-15 15:31:53 -06:00
Brooke Kuhlmann
1769a8234a Added README production and development setup instructions
Improves the setup experience by explaining how to use the project for
production and/or development purposes.
2020-03-15 12:09:09 -06:00
Brooke Kuhlmann
788aec169a Updated Circle CI build label
Properly displays the correct label for building of the project.
2020-03-15 08:38:10 -06:00
Brooke Kuhlmann
0ad8cc432c Updated to Git Cop 4.0.0
[Details](https://github.com/bkuhlmann/git-cop/releases/tag/4.0.0).
2020-01-01 13:54:02 -07:00
Brooke Kuhlmann
48deaa9f46 Added version release notes. 2020-01-01 08:21:04 -07:00
Brooke Kuhlmann
0899233085 Updated to Ruby 2.7.0.
[Details](https://is.gd/mGVQIu).

Merry Christmas!
2019-12-25 06:52:02 -07:00
Brooke Kuhlmann
39cbeefef8 Refactored caffeinate machine function to process grep.
Leverages `pgrep` instead of `ps` for more efficient code.
2019-12-07 14:38:52 -07:00
Brooke Kuhlmann
98c4663f43 Updated README screencast.
Necessary to support the new format and branding.
2019-10-31 07:20:18 -06:00
Brooke Kuhlmann
76c1250cc5 Added Startup Security Utility to README.
Explains how to use these utilities which is useful to know when
dealing with new hardware security features.

[ci skip]
2019-10-13 13:43:52 -06:00
Brooke Kuhlmann
006593b402 Added version release notes. 2019-10-12 10:52:38 -06:00
Brooke Kuhlmann
f989334a11 Updated to macOS Catalina.
[Features](https://www.apple.com/macos/catalina).
2019-10-12 10:49:42 -06:00
Brooke Kuhlmann
b2949b0b7b Updated to Rake 13.0.0.
Provides future support for Ruby 2.7.0 and drops support for Ruby
versions older than 2.2.0.

[Details](https://github.com/ruby/rake/blob/master/History.rdoc).
2019-10-01 20:22:12 -06:00
Brooke Kuhlmann
40bd5dea2d Updated to Ruby 2.6.5.
Resolves several security vulnerabilities:

- CVE-2019-16255: A code injection vulnerability of Shell#[] and
  Shell#test
- CVE-2019-16254: HTTP response splitting in WEBrick (Additional fix)
- CVE-2019-15845: A NUL injection vulnerability of File.fnmatch and
  File.fnmatch?
- CVE-2019-16201: Regular Expression Denial of Service vulnerability of
  WEBrick’s Digest access authentication

[Details](https://is.gd/qWSrzR)
2019-10-01 17:51:03 -06:00
Brooke Kuhlmann
f8619eedc8 Added version release notes. 2019-09-01 09:02:55 -06:00
Brooke Kuhlmann
3b5fc4e36f Updated to Ruby 2.6.4.
Resolves issues with jQuery vulnerabilities in RDoc.

- [Ruby 2.6.4 Release Notes](https://is.gd/dNIrnn).
- [Multiple jQuery vulnerabilities in RDoc](https://is.gd/RNRZHr).
2019-08-28 07:23:15 -06:00
Brooke Kuhlmann
dde21b5bef Updated README screencast tutorial.
Provides improved descriptions, examples, and new theming.

[ci skip]
2019-08-18 11:16:37 -06:00
Brooke Kuhlmann
eb286cd150 Added version release notes. 2019-08-01 06:53:28 -06:00
Brooke Kuhlmann
c2c9ebf14e Added file install function.
Was originally removed in this commit (a895090ca9) and has been
restored in order to handle situations where we have only a single file
install.

For example, the MacOS Config project needs this function in order to
properly install the Pathogem (Vim) file.
2019-07-20 10:43:13 -06:00
Brooke Kuhlmann
6992d11d1c Added version release notes. 2019-06-01 11:49:58 -06:00
Brooke Kuhlmann
f6428c7245 Updated to Git Cop 3.5.0.
[Changes](https://github.com/bkuhlmann/git-cop/releases/tag/3.5.0).
2019-06-01 10:15:33 -06:00
Brooke Kuhlmann
5e26d111c1 Updated contributing documentation.
Minor wording and sentence structure clean up.

[ci skip]
2019-05-18 12:00:36 -06:00
Brooke Kuhlmann
b45af77b5c Added version release notes. 2019-05-01 20:53:27 -06:00
Brooke Kuhlmann
41f6fae742 Added project icon to README.
Further stylizes the project.

[ci skip]
2019-04-28 10:00:45 -06:00
Brooke Kuhlmann
3ee1d855bf Updated to Ruby 2.6.3.
[Details](https://is.gd/wKUEHw).
2019-04-17 17:43:02 -06:00
Brooke Kuhlmann
a77af9c21f Added version release notes. 2019-04-01 10:38:23 -06:00
Brooke Kuhlmann
4b7c940850 Updated to Ruby 2.6.2.
Addresses serveral bug and security fixes.

[Details](https://is.gd/lIVAFn)
2019-03-13 12:43:28 -06:00
Brooke Kuhlmann
295578875f Added XCode installer fix to troubleshooting section.
I've not experienced this yet but others have so adding to the
troubleshooting section in case it is of help.

[ci skip]
2019-03-13 07:07:24 -06:00
Brooke Kuhlmann
1ae3ae1134 Updated to Ruby 2.6.1.
Fixed major issue with `Net::Protocol::BufferedIO#write` raising
`NoMethodError` when sending large multi-byte strings.

[Details](https://is.gd/cQ8wcl).
2019-01-30 06:50:09 -07:00
Brooke Kuhlmann
d78eb3063d Added version release notes. 2019-01-01 12:16:07 -07:00
Brooke Kuhlmann
a547d061b2 Updated to Git Cop 3.0.0.
Includes enhanced support for XDG environment variables which don't
require support of additional tools like [direnv](https://direnv.net).

[Changes](https://github.com/bkuhlmann/git-cop/releases/tag/3.0.0).
2019-01-01 10:21:29 -07:00
Brooke Kuhlmann
f58f146074 Added Circle CI Bundler cache.
Speeds up the builds by pulling from the Bundler cache (when Gemfile
has not changed).
2018-12-30 10:45:52 -07:00
Brooke Kuhlmann
6c2de5a5bb Fixed Circle CI cache for Ruby version.
Was missing the checksum which would cause Ruby to be downloaded and
rebuilt each time.

The Docker image has been updated to use an unspecified version to
reduce version maintenance.

The `CI_RUBY_VERSION` environment variable was introduced to be
dynamically set based on value in the `.ruby-version` for improved
maintainability.
2018-12-30 10:01:44 -07:00
Brooke Kuhlmann
4d9ad7315d Removed download file function.
No longer used or recommended now that the `install_*` functions
consistently install applications in the correct location based on
application name.
2018-12-29 15:13:36 -07:00
Brooke Kuhlmann
a895090ca9 Fixed program installs.
Modifies and renames the original `install_file` function so it
calculates install path based on application name. This ensures
`install_program` has the same behavior as found with similar install
functions:
  - `install_dmg_app`
  - `install_dmg_pkg`
  - `install_zip_app`
  - `install_zip_pkg`
  - `install_tar_app`
2018-12-29 15:13:36 -07:00
Brooke Kuhlmann
0c7ae2ba4e Added README boot disk documentation.
Provides an additional reference for convenience when the scripts for
creating the boot disk are no longer available.
2018-12-29 14:06:03 -07:00
Brooke Kuhlmann
caa2adb45c Removed Java development tools from setup.
These tools were originally necessary for some of the Homebrew
applications to install successfully (especially Elasticsearch) but
those requirements are no longer necessary. This also reduces the setup
friction by requiring less manual work on behalf of the installer.
2018-12-29 14:06:03 -07:00
Brooke Kuhlmann
cc75094d5f Added README troubleshooting section.
Discovered this situation while wanting to rebuild a recently rebuilt
machine of the same operation system version. At first, thought the
original bootdisk was corrupted but turns out the system NVRAM/PRAM was
causing the issue.
2018-12-29 14:06:03 -07:00
Brooke Kuhlmann
d03762425a Fixed installation of apps with no extension.
Some apps are binaries packaged within a DMG, zip, etc. that have no
extension but are executable. These are meant to go in the
`/usr/local/bin` folder.

This corresponds with the code found in the `installers.sh` file (see
the `install_app` function).
2018-12-29 14:06:03 -07:00
Brooke Kuhlmann
2d58c953e1 Updated to Ruby 2.6.0.
[Changes](https://is.gd/MuTHWG).
2018-12-25 11:29:03 -07:00
Brooke Kuhlmann
bb329535c7 Added version release changes. 2018-11-01 20:01:55 -06:00
Brooke Kuhlmann
72f5fcb03e Removed unnecessary source code comments.
Reduced stating the obvious (in many cases) in order to improve
readability and reduce lines of code.
2018-10-28 13:35:51 -06:00
Brooke Kuhlmann
7da69e543f Updated to Java SE Development Kit 11.
Links to latest release of Java SE SDK.
2018-10-27 11:59:21 -06:00
Brooke Kuhlmann
0b5c5a6cd8 Updated to Ruby 2.5.3.
Fixes development packaging issues absent in Ruby 2.5.2.

[Details](https://is.gd/tYAZvF).
2018-10-21 09:47:23 -06:00
Brooke Kuhlmann
450c04e126 Updated to Ruby 2.5.2.
Includes important security patches. [Details](https://is.gd/60JxWj).
2018-10-17 12:54:37 -06:00
Brooke Kuhlmann
8305d07ffb Added version release changes. 2018-10-01 19:56:56 -06:00
Brooke Kuhlmann
ff09e25ea5 Added XCode install tip.
Helpful for first-time installers not familar with XCode. Also reduces
confusion with license window which always seems to appear behind
current window.
2018-09-30 10:34:17 -06:00
Brooke Kuhlmann
be396b9581 Updated to Java SE Development Kit 10.
Provides a link to the latest JDK.
2018-09-25 17:35:28 -06:00
Brooke Kuhlmann
6dd6d93bb8 Updated boot disk creation to macOS Mojave.
Provides support for the latest
[macOS](https://www.apple.com/macos/mojave) release.
2018-09-25 17:35:28 -06:00
Brooke Kuhlmann
98d921527c Updated to Contributor Covenant Code of Conduct 1.4.1.
The biggest change is the links all use HTTPS now. Formatting was
corrected to wrap at the 100th column as well.

[ci skip]
2018-08-12 07:10:08 -06:00
Brooke Kuhlmann
c01bdeb393 Added version release changes. 2018-08-01 19:51:36 -06:00
Brooke Kuhlmann
f6610849eb Updated Git checkout to silence detached head warnings.
Avoids displaying the following warning in the logs when checking out a
specific version of a project for install purposes:

    You are in 'detached HEAD' state. You can look around, make
    experimental changes and commit them, and you can discard any
    commits you make in this state without impacting any branches by
    performing another checkout.

    If you want to create a new branch to retain commits you create,
    you may do so (now or later) by using -b with the checkout command
    again. Example:

      git checkout -b <new-branch-name>

    HEAD is now at f836f876a178 Added version release changes.
2018-08-01 19:31:23 -06:00
Brooke Kuhlmann
d0c2335f35 Removed restorer functions.
No longer needed as these have been eclipsed by the restore from backup
functionality that uses rsync.
2018-08-01 19:31:23 -06:00
Brooke Kuhlmann
cc9fc3a2f9 Removed Java install support.
No longer used as the installer is prompted for instead.
2018-07-29 17:41:30 -06:00
Brooke Kuhlmann
023c8bbae2 Refactored function parameter documentation.
Cleaned up function documentation to be consistent with rest of
project.
2018-07-29 16:05:09 -06:00
Brooke Kuhlmann
5c12a47f11 Added App Store application verification.
Ensures all listed App Store applications are installed. Otherwise, it
lists those which are not.
2018-07-29 15:48:01 -06:00
Brooke Kuhlmann
cc1b7527fe Added Homebrew cask application verifier.
Verifies installation of Homebrew casks by ensuring installed
applications cross check against defined list.
2018-07-29 15:02:59 -06:00
Brooke Kuhlmann
2f6b385f2f Refactored library function order.
Moved primary functions above secondary functions for easier
readability.
2018-07-29 13:56:00 -06:00
Brooke Kuhlmann
6c06f7107b Fixed verification of Homebrew formulas.
The `verify_homebrew_formulas` function will no longer error when
checking Homebrew formulas due to invalid function name.
2018-07-29 13:37:36 -06:00
Brooke Kuhlmann
da81619140 Updated boot disk format documentation.
Added emphasis for using *Mac OS Extended (Journaled)* format for the
USB drive and *APFS (Encrypted)* for the main drive.
2018-07-28 18:15:39 -06:00
Brooke Kuhlmann
6c4fc52511 Updated README documentation.
Minor edits and clarifications.
2018-07-28 18:15:39 -06:00
Brooke Kuhlmann
ccb9aa8c1d Fixed Markdown ordered list numbering.
Ensures ordered lists start at one instead of zero.

[ci skip]
2018-07-20 10:30:20 -06:00
Brooke Kuhlmann
940ad7e622 Updated Semantic Versioning links to be HTTPS.
It's best to be secure by default.

[ci skip]
2018-06-30 17:10:03 -06:00
Brooke Kuhlmann
f7fb380233 Updated project changes to use semantic versions.
Keeps project changes/history labeled with consistent version labels.

[ci skip]
2018-04-01 12:43:14 -06:00
Brooke Kuhlmann
c0b9be502b Added version release changes. 2018-04-01 10:56:35 -06:00
Brooke Kuhlmann
66cd8d988e Updated to Git Cop 2.2.0.
[Changes](https://is.gd/OEDYpE).
2018-04-01 09:07:07 -06:00
Brooke Kuhlmann
955af0fc9e Updated to Ruby 2.5.1.
[Details](https://is.gd/hSEMaL).
2018-03-30 17:32:36 -06:00
Brooke Kuhlmann
9730e0ce45 Updated to Circle CI 2.0.0 configuration.
Uses latest configuration version in order to not be caught off-guard
if/when they drop v1.0.0 support.

[Details](https://circleci.com/docs/2.0).
2018-01-28 07:44:33 -07:00
Brooke Kuhlmann
94373dd5e8 Updated README screencast tutorial.
Updated to use latest version of software (not that the features have
changed much).
2018-01-07 14:14:22 -07:00
Brooke Kuhlmann
87282969de Updated README license information.
Simplified the text by removing the "(c)" as the use of "Copyright" is
good enough.

[ci skip]
2018-01-06 15:00:50 -07:00
Brooke Kuhlmann
6a6286755e Removed Patreon badge from README.
No longer planning to use this service.

[ci skip]
2018-01-02 20:25:45 -07:00
Brooke Kuhlmann
5866049618 Added version release changes. 2018-01-01 14:00:44 -07:00
Brooke Kuhlmann
3cba8eaa48 Updated to Apache 2.0 license.
Out of all permissive licenses, this provides the clearest terms and
conditions.

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

[ci skip]
2017-12-31 10:17:06 -07:00
Brooke Kuhlmann
cd89faac07 Updated to Ruby 2.5.0.
[Changes](http://bit.ly/2C4KviX).
2017-12-25 06:49:05 -07:00
Brooke Kuhlmann
ea8944a1dc Updated to Ruby 2.4.3.
Fixes a `Net::FTP` security issue.

[Details](http://bit.ly/2jU2KzV).
2017-12-14 19:40:00 -07:00
Brooke Kuhlmann
1e6e9a43bd Added Gemfile.lock to .gitignore.
It's not necessary to track exact details of the gems used in this
project as they are used for build purposes only.
2017-12-10 10:18:56 -07:00
Brooke Kuhlmann
68c1ea0515 Added version release changes. 2017-11-26 15:26:28 -07:00
Brooke Kuhlmann
419fceba0c Updated boot disk documenation to mention APFS.
Aids new installs with the correct option to choose from the menu
prompt.
2017-11-26 08:59:06 -07:00
Brooke Kuhlmann
9fba750712 Updated to Rake 12.3.0.
[Changes](http://bit.ly/2AU14wd).
2017-11-18 08:53:59 -07:00
Brooke Kuhlmann
de9e9dc73e Updated Gemfile.lock file.
Was accidentally missed as part of the previous commit.
2017-11-05 17:12:04 -07:00
Brooke Kuhlmann
0f13af9692 Updated to Git Cop 1.7.0.
[Changes](http://bit.ly/2AcYDV4).
2017-11-05 17:04:03 -07:00
Brooke Kuhlmann
7133361277 Updated to Bundler 1.16.0.
[Changes](http://bit.ly/2hFrBX5).
2017-11-04 13:53:22 -06:00
Brooke Kuhlmann
bc01beac6a Updated to Rubocop 0.51.0.
[Changes](http://bit.ly/2hlepWS).

There is a bug with Rubocop 0.51.0 where the `Style/CommentedKeyword`
cop raises false positives but can be ignored until the next release of
Rubocop is issued.
2017-10-29 15:08:27 -06:00
Brooke Kuhlmann
18ff862a4a Added version release changes. 2017-10-01 15:42:33 -06:00
Brooke Kuhlmann
c6ef97a88b Updated boot disk creation to use macOS High Sierra.
Necessary to create a boot disk for the latest macOS version.
2017-10-01 11:40:24 -06:00
Brooke Kuhlmann
67a17a0113 Updated to Ruby 2.4.2.
[Details](http://bit.ly/2yfBm4I).
2017-09-16 17:34:04 -06:00
Brooke Kuhlmann
e5f2051412 Updated to Git Cop 1.6.0.
[Changes](https://github.com/bkuhlmann/git-cop/releases/tag/v1.6.0).
2017-08-27 08:49:41 -06:00
Brooke Kuhlmann
bbdedb1a56 Updated gem dependencies. 2017-08-27 08:07:13 -06:00
Brooke Kuhlmann
cd595f1bd1 Fixed table of contents.
[ci skip]
2017-08-03 20:03:41 -06:00
Brooke Kuhlmann
e89a05fcbf Updated to Git Cop 1.5.0.
[Changes](https://github.com/bkuhlmann/git-cop/releases/tag/v1.5.0).
2017-07-30 16:03:20 -06:00
Brooke Kuhlmann
048908f2ba Updated to Git Cop 1.3.0.
- [Changes](https://github.com/bkuhlmann/git-cop/releases/tag/v1.3.0).
2017-07-17 20:15:58 -06:00
35 changed files with 1060 additions and 753 deletions

1
.gitignore vendored Normal file
View File

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

View File

@@ -1 +1 @@
2.4.1
2.7.1

172
CHANGES.adoc Normal file
View File

@@ -0,0 +1,172 @@
= Changes
== 8.1.0 (2020-04-01)
- Added README production and development setup instructions
- Updated Circle CI build label
- Updated README screencast to use larger image
- Updated documentation to ASCII Doc format
- Updated to Code of Conduct 2.0.0
- Updated to Git Cop 4.0.0
- Updated to Ruby 2.7.1
- Removed README images
== 8.0.1 (2020-01-01)
* Added Startup Security Utility to README.
* Updated README screencast.
* Updated to Ruby 2.7.0.
* Refactored caffeinate machine function to process grep.
== 8.0.0 (2019-10-12)
* Updated to Rake 13.0.0.
* Updated to Ruby 2.6.5.
* Updated to macOS Catalina.
== 7.2.1 (2019-09-01)
* Updated README screencast tutorial.
* Updated to Ruby 2.6.4.
== 7.2.0 (2019-08-01)
* Added file install function.
== 7.1.2 (2019-06-01)
* Updated contributing documentation.
* Updated to Git Cop 3.5.0.
== 7.1.1 (2019-05-01)
* Added project icon to README.
* Updated to Ruby 2.6.3.
== 7.1.0 (2019-04-01)
* Added XCode installer fix to troubleshooting section.
* Updated to Ruby 2.6.1.
* Updated to Ruby 2.6.2.
== 7.0.0 (2019-01-01)
* Fixed Circle CI cache for Ruby version.
* Fixed installation of apps with no extension.
* Fixed program installs.
* Added Circle CI Bundler cache.
* Added README boot disk documentation.
* Added README troubleshooting section.
* Updated to Git Cop 3.0.0.
* Updated to Ruby 2.6.0.
* Removed Java development tools from setup.
* Removed download file function.
== 6.1.0 (2018-11-01)
* Updated to Java SE Development Kit 11.
* Updated to Ruby 2.5.2.
* Updated to Ruby 2.5.3.
* Removed unnecessary source code comments.
== 6.0.0 (2018-10-01)
* Added XCode install tip.
* Updated boot disk creation to macOS Mojave.
* Updated to Contributor Covenant Code of Conduct 1.4.1.
* Updated to Java SE Development Kit 10.
== 5.0.0 (2018-08-01)
* Fixed Markdown ordered list numbering.
* Fixed verification of Homebrew formulas.
* Added App Store application verification.
* Added Homebrew cask application verifier.
* Updated Git checkout to silence detached head warnings.
* Updated README documentation.
* Updated Semantic Versioning links to be HTTPS.
* Updated boot disk format documentation.
* Updated project changes to use semantic versions.
* Removed Java install support.
* Removed restorer functions.
* Refactored function parameter documentation.
* Refactored library function order.
== 4.1.0 (2018-04-01)
* Updated README license information.
* Updated README screencast tutorial.
* Updated to Circle CI 2.0.0 configuration.
* Updated to Git Cop 2.2.0.
* Updated to Ruby 2.5.1.
* Removed Patreon badge from README.
== 4.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.
== 3.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.
== 3.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.
== 2.2.0 (2017-07-16)
* Added Git Cop support.
* Updated CONTRIBUTING documentation.
* Updated GitHub templates.
* Updated README headers.
* Updated gem dependencies.
== 2.1.0 (2017-04-29)
* Fixed Java SE Development Kit install.
* Fixed install-all command
== 2.0.0 (2017-04-09)
* Added Homebrew Casks install script.
* Updated README semantic versioning order.
* Updated contributing documentation.
* Refactored Homebrew software as Homebrew Formulas.
== 1.3.1 (2017-01-08)
* Fixed install of zip app downloads with sub-directories.
== 1.3.0 (2017-01-01)
* Updated README versioning documentation.
* Removed CHANGELOG.md (use CHANGES.md instead).
== 1.2.0 (2016-10-12)
* Fixed reinstaller path issues with application and extension scripts.
* Added screencast to README.
== 1.1.0 (2016-10-11)
* Fixed Bash script header to dynamically load correct environment.
* Fixed verification of Homebrew application installs.
* Added script hook for App Store software install.
* Added script hooks for unfinished custom configurations.
* Updated and clarified README documentation.
== 1.0.0 (2016-10-05)
* Initial version.

View File

@@ -1,45 +0,0 @@
# 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.
- Fixed install-all command
# v2.0.0 (2017-04-09)
- Added Homebrew Casks install script.
- Updated README semantic versioning order.
- Updated contributing documentation.
- Refactored Homebrew software as Homebrew Formulas.
# v1.3.1 (2017-01-08)
- Fixed install of zip app downloads with sub-directories.
# v1.3.0 (2017-01-01)
- Updated README versioning documentation.
- Removed CHANGELOG.md (use CHANGES.md instead).
# v1.2.0 (2016-10-12)
- Fixed reinstaller path issues with application and extension scripts.
- Added screencast to README.
# v1.1.0 (2016-10-11)
- Fixed Bash script header to dynamically load correct environment.
- Fixed verification of Homebrew application installs.
- Added script hook for App Store software install.
- Added script hooks for unfinished custom configurations.
- Updated and clarified README documentation.
# v1.0.0 (2016-10-05)
- Initial version.

112
CODE_OF_CONDUCT.adoc Normal file
View File

@@ -0,0 +1,112 @@
= Contributor Covenant Code of Conduct
== Our Pledge
We as members, contributors, and leaders pledge to make participation in our community a
harassment-free experience for everyone, regardless of age, body size, visible or invisible
disability, ethnicity, sex characteristics, gender identity and expression, level of experience,
education, socio-economic status, nationality, personal appearance, race, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and
healthy community.
== Our Standards
Examples of behavior that contributes to a positive environment for our community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the
experience
* Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address, without their
explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
== Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior
and will take appropriate and fair corrective action in response to any behavior that they deem
inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits,
code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and
will communicate reasons for moderation decisions when appropriate.
== Scope
This Code of Conduct applies within all community spaces, and also applies when an individual is
officially representing the community in public spaces. Examples of representing our community
include using an official e-mail address, posting via an official social media account, or acting as
an appointed representative at an online or offline event.
== Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
leaders responsible for enforcement at link:mailto:brooke@alchemists.io?subject=Conduct[Alchemists].
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any
incident.
== Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining the consequences for
any action they deem in violation of this Code of Conduct:
=== 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or
unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing clarity around the
nature of the violation and an explanation of why the behavior was inappropriate. A public apology
may be requested.
=== 2. Warning
**Community Impact**: A violation through a single incident or series of actions.
**Consequence**: A warning with consequences for continued behavior. No interaction with the people
involved, including unsolicited interaction with those enforcing the Code of Conduct, for a
specified period of time. This includes avoiding interactions in community spaces as well as
external channels like social media. Violating these terms may lead to a temporary or permanent ban.
=== 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including sustained inappropriate
behavior.
**Consequence**: A temporary ban from any sort of interaction or public communication with the
community for a specified period of time. No public or private interaction with the people involved,
including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this
period. Violating these terms may lead to a permanent ban.
=== 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community standards, including
sustained inappropriate behavior, harassment of an individual, or aggression toward or
disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the community.
== Attribution
This Code of Conduct is adapted from the
link:https://www.contributor-covenant.org/version/2/0/code_of_conduct.html[Contributor Covenant,
version 2.0].
Community Impact Guidelines were inspired by link:https://github.com/mozilla/diversity[Mozilla's
code of conduct enforcement ladder].
For answers to common questions about this code of conduct, see the
link:https://www.contributor-covenant.org/faq[FAQ]. Translations are available
link:https://www.contributor-covenant.org/translations[here].

View File

@@ -1,61 +0,0 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race,
religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
project or its community. Examples of representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed representative at an online or offline
event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
[brooke@alchemists.io](mailto:brooke@alchemists.io). All complaints will be reviewed and investigated and will result in
a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain
confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be
posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
repercussions as determined by other members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

22
CONTRIBUTING.adoc Normal file
View File

@@ -0,0 +1,22 @@
= 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.
== Code
. Read the project link:README.adoc[README] before starting.
. Fork and clone the `master` branch of this repository locally.
. Ensure there are no setup, usage, and/or test issues.
. Add tests for new functionality and ensure they pass.
. Submit a pull request, follow the instructions provided, and ensure the build passes.
== Issues
Submit an issue via the GitHub Issues tab (assuming one does not already exist) and follow the
instructions provided.
== Feedback
* Expect a response within one to three business days.
* Changes, alternatives, and/or improvements may be suggested upon review.

View File

@@ -1,22 +0,0 @@
# Contributing
Thanks for taking an interest in this open source project. Your support and involvement is greatly
appreciated. The following sections detail what you need to know in order to contribute.
## Code
0. Read the project README before starting.
0. Fork the `master` branch of this repository and clone the fork locally.
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, follow the instructions it provides, and ensure the build passes.
## Issues
0. Submit an issue via the GitHub Issues tab (assuming one does not
already exist) and follow the instructions it provides.
## Feedback
- Expect a response within one to three business days.
- Changes, alternatives, and/or improvements might be suggested upon review.

View File

@@ -2,5 +2,5 @@
source "https://rubygems.org"
gem "rake", "~> 12.0"
gem "git-cop", "~> 1.3"
gem "rake", "~> 13.0"
gem "git-cop", "~> 4.0"

View File

@@ -1,28 +0,0 @@
GEM
remote: https://rubygems.org/
specs:
equatable (0.5.0)
git-cop (1.3.0)
pastel (~> 0.7)
refinements (~> 4.1)
runcom (~> 1.1)
thor (~> 0.19)
pastel (0.7.1)
equatable (~> 0.5.0)
tty-color (~> 0.4.0)
rake (12.0.0)
refinements (4.1.0)
runcom (1.1.0)
refinements (~> 4.1)
thor (0.19.4)
tty-color (0.4.2)
PLATFORMS
ruby
DEPENDENCIES
git-cop (~> 1.3)
rake (~> 12.0)
BUNDLED WITH
1.15.1

162
LICENSE.adoc Normal file
View File

@@ -0,0 +1,162 @@
= Apache License
Version 2.0, January 2004
http://www.apache.org/licenses
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
== 1. Definitions
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
Sections 1 through 9 of this document.
"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:
. You must give any other recipients of the Work or Derivative Works a copy of this License; and
. You must cause any modified files to carry prominent notices stating that You changed the files;
and
. 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
. 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 link:https://www.alchemists.io[Alchemists].
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 link:https://www.apache.org/licenses/LICENSE-2.0[copy]
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.

View File

@@ -1,20 +0,0 @@
Copyright (c) 2016 [Alchemists](https://www.alchemists.io).
Permission is hereby granted, free of charge, to any person obtaining
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
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

251
README.adoc Normal file
View File

@@ -0,0 +1,251 @@
:toc: macro
:toclevels: 5
:figure-caption!:
= macOS
[link=https://circleci.com/gh/bkuhlmann/mac_os]
image::https://circleci.com/gh/bkuhlmann/mac_os.svg?style=svg[Circle CI Status]
Shell scripts for automated macOS machine setup.
This project is a framework for automating the setup of a macOS machine. In order to illustrate the
potential of what this project can do, please see the companion
link:https://www.alchemists.io/projects/mac_os-config[macOS Config] project for details. The _macOS
Config_ project is an opinionated configuration which meets the needs of my development environment
but is also meant to serve as an example and guide for building your own personalized setup. Here is
how the two projects are meant to be used:
* *macOS* (this project) - The foundation framework for building customizated macOS machine setups.
* *link:https://www.alchemists.io/projects/mac_os-config[macOS Configuration]* - The layer on top of
this _macOS_ project which defines a custom machine setup and base implementation. The project is
meant to be forked for as many custom machine setups as needed.
toc::[]
== Features
* Provides a command line interface, written in Bash, with no additional dependencies for
installation and management of a macOS machine.
* Supports macOS boot disk creation for fresh install of operating system.
* Downloads and installs link:https://developer.apple.com/xcode[Xcode Command Line Tools].
* Downloads, installs, and configures link:http://brew.sh[Homebrew Formulas].
* Downloads, installs, and configures link:https://caskroom.github.io[Homebrew Casks].
* Downloads, installs, and configures link:http://www.apple.com/macosx/whats-new/app-store.html[App
Store] software.
* Downloads, installs, and configures non-App Store software applications.
* Downloads, installs, and configures software application extensions.
* Applies basic and default software settings.
* Sets up and configures installed software for use.
* Supports restoration of machine backups.
== Screencast
[link=https://www.alchemists.io/screencasts/mac_o_s.html]
image::https://www.alchemists.io/images/screencasts/mac_o_s/cover-original.png[Screencast,role=focal_point]
== Requirements
. https://www.apple.com/macos/catalina[macOS Catalina] (with latest software updates applied)
. https://developer.apple.com/xcode[Xcode] (with accepted license agreement)
== Setup
=== Production
To install, run:
[source,bash]
----
git clone https://github.com/bkuhlmann/mac_os.git
cd mac_os
git checkout 8.1.0
----
=== Development
To contribute, run:
[source,bash]
----
git clone https://github.com/bkuhlmann/mac_os.git
cd mac_os
----
== Usage
Run the following:
[source,bash]
----
bin/run
----
You will be presented with the following options (listed in order of
use):
....
Boot:
B: Create boot disk.
Install:
b: Apply basic settings.
t: Install development tools.
hf: Install Homebrew Formulas.
hc: Install Homebrew Casks.
m: Install Mac App Store software.
a: Install application software.
x: Install application software extensions.
d: Apply default settings.
s: Setup installed software.
i: Install everything (i.e. executes all install options).
Restore:
R: Restore settings from backup.
Manage:
c: Check status of managed software.
C: Caffeinate machine.
ua: Uninstall application software.
ux: Uninstall application software extension.
ra: Reinstall application software.
rx: Reinstall application software extension.
w: Clean work (temp) directory.
q: Quit/Exit.
....
Choose option `i` to run a full install or select a specific option to run a single action. Each
option is designed to be re-run if necessary. This can also be handy for performing upgrades,
re-running a missing/failed install, etc.
The option prompt can be skipped by passing the desired option directly to the `bin/run` script. For
example, executing `bin/run i` will execute the full install process.
The machine should be rebooted after all install tasks have completed to ensure all settings have
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.
=== Boot Disk
When attempting to create a boot disk via `bin/run B`, youll be presented with the following
documentation (provided here for reference):
....
macOS Boot Disk Tips
- Use a USB drive (8GB or higher).
- Use Disk Utility to format the USB drive as "Mac OS Extended (Journaled)".
- Use Disk Utility to label the USB drive as "Untitled".
macOS Boot Disk Usage:
1. Insert the USB boot disk into the machine to be upgraded.
2. Reboot the machine.
3. Hold down the OPTION key before the Apple logo appears.
4. Select the USB boot disk from the menu.
5. Use Disk Utility to format the machine's drive as "APFS (Encrypted)".
6. Install the new operating system.
macOS Reinstall:
1. Click the Apple icon from the operating system main menu.
2. Select the "Restart..." menu option.
3. Hold down the COMMAND+R keys before the Apple logo appears.
4. Wait for the macOS installer to load from the recovery partition.
5. Use the dialog options to launch Disk Utility, reinstall the system, etc.
....
Depending on your security settings, you might need to use the Startup
Security Utility before using the Boot Disk (see below).
=== https://support.apple.com/en-us/HT208198[Startup Security Utility]
With newer hardware, you should be running with the Apple T2 Security Chip (found via  → About This
Mac → Overview → System Report → Controller). In order to boot your machine using the Boot Disk,
youll need to _temporarily_ disable the default security settings as follows:
* Turn on or restart your Mac, then press and hold `COMMAND + R` immediately after seeing the Apple
logo.
* Select Utilities → Startup Security Utility from the main menu.
* Click _Turn Off Firmware Password_.
* Select _Secure Boot: No Security_.
* Select _External Boot: Allow booting from external media_.
* Quit the utility and restart the machine.
Youll now be able to boot your system with the Boot Disk (see above).
After the new operating system has been installed via the Boot Disk, _ensure you return to the
Startup Security Utility and re-enable the following settings_:
* Click _Turn On Firmware Password_.
* Select _Secure Boot: Full Security_.
* Select _External Boot: Disallow booting from external or removable media_.
=== Customization
All executable scripts can be found in the `bin` folder:
* `bin/apply_basic_settings`: Applies basic, initial, settings for setting up a machine. _Can be
customized._
* `bin/apply_default_settings`: Applies useful system and application defaults. _Can be customized._
* `bin/create_boot_disk`: Creates macOS boot disk.
* `bin/install_app_store`: Installs macOS, GUI-based, App Store applications. _Can be customized._
* `bin/install_applications`: Installs macOS, GUI-based, non-App Store applications. _Can be
customized._
* `bin/install_dev_tools`: Installs macOS development tools required by Homebrew.
* `bin/install_extensions`: Installs macOS application extensions and add-ons. _Can be customized._
* `bin/install_homebrew_casks`: Installs Homebrew Formulas. _Can be customized._
* `bin/install_homebrew_formulas`: Installs Homebrew Casks. _Can be customized._
* `bin/restore_backup`: Restores system/application settings from backup image. _Can be customized._
* `bin/run`: The main script and interface for macOS setup.
* `bin/setup_software`: Configures and launches (if necessary) installed software. _Can be
customized._
The `lib` folder provides the base framework for installing, re-installing, and uninstalling
software. Everything provided via the link:https://www.alchemists.io/projects/mac_os-config[macOS
Config] project is built upon the functions found in the `lib` folder. See the
link:https://www.alchemists.io/projects/mac_os-config[macOS Config] project for further details.
* `lib/settings.sh`: Defines global settings for software applications, extensions, etc.
== Troubleshooting
* When using the boot disk, you might experience a situation where you see a black screen with a
white circle and diagonal line running through it. This means macOS lost or cant find the boot
disk for some reason. To correct this, shut down and boot up the system again while holding down
the `OPTION+COMMAND+R+P` keys simultaneously. You might want to wait for the system boot sound to
happen a few times before releasing the keys. This will clear the system NVRAM/PRAM. At this point
you can shut down and restart the system following the boot disk instructions (the boot disk will
be recognized now).
* Sometimes, when installing XCode development tools (i.e. the `t` option), not all of the macOS
headers will be installed. This can cause issues with compiling and building native packages. For
example: `fatal error: 'stdio.h' file not found`. This can happen due to an intermittent bug with
the XCode installer. To fix this, youll need to install this package:
`/Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg`. Depending on
your system, the version might differ, so look for a `*.pkg` in the
`/Library/Developer/CommandLineTools/Packages` folder.
== Versioning
Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means:
* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
* 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
Please note that this project is released with a link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
participating in this project you agree to abide by its terms.
== Contributions
Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
== License
Read link:LICENSE.adoc[LICENSE] for details.
== History
Read link:CHANGES.adoc[CHANGES] for details.
== Credits
Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann.html[Brooke Kuhlmann].

191
README.md
View File

@@ -1,191 +0,0 @@
# 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.
This project is a framework for automating the setup of a macOS machine. In order to illustrate the
potential of what this project can do, please see the companion
[macOS Config](https://github.com/bkuhlmann/mac_os-config) project for details. The *macOS Config*
project is an opinionated configuration which meets the needs of my development environment but is
also meant to serve as an example and guide for building your own personalized setup. Here is how
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*
project which defines a custom machine setup and base implementation. The project is meant to be
forked for as many custom machine setups as needed.
<!-- Tocer[start]: Auto-generated, don't remove. -->
## Table of Contents
- [Features](#features)
- [Screencast](#screencast)
- [Requirements](#requirements)
- [Setup](#setup)
- [Usage](#usage)
- [Customization](#customization)
- [Versioning](#versioning)
- [Code of Conduct](#code-of-conduct)
- [Contributions](#contributions)
- [License](#license)
- [History](#history)
- [Credits](#credits)
<!-- Tocer[finish]: Auto-generated, don't remove. -->
## Features
- Provides a command line interface, written in Bash with no additional dependencies, for
installation and management of a macOS machine.
- Supports macOS boot disk creation for setting up a machine with a fresh install of the operation
system.
- Downloads and installs development tools (required by Homebrew):
- [Xcode Command Line Tools](https://developer.apple.com/xcode)
- [Java SE Development Kit](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
- Downloads, installs, and configures [Homebrew Formulas](http://brew.sh).
- Downloads, installs, and configures [Homebrew Casks](https://caskroom.github.io).
- Downloads, installs, and configures
[App Store](http://www.apple.com/macosx/whats-new/app-store.html) software.
- Downloads, installs, and configures non-App Store software applications.
- Downloads, installs, and configures software application extensions.
- Applies basic and default software settings.
- Sets up and configures installed software for use.
- Supports restoration of machine backups.
## Screencast
[![asciicast](https://asciinema.org/a/88971.png)](https://asciinema.org/a/88971)
## Requirements
0. [macOS Sierra](https://www.apple.com/macos) (with latest software updates applied)
0. [Xcode](https://developer.apple.com/xcode) (with accepted license agreement)
## Setup
Open a terminal window and execute one of the following setup sequences depending on your version
preference:
Current Version (stable):
git clone https://github.com/bkuhlmann/mac_os.git
cd mac_os
git checkout v2.2.0
Master Version (unstable):
git clone https://github.com/bkuhlmann/mac_os.git
cd mac_os
## Usage
Run the following script:
bin/run
You will be presented with the following options:
Boot:
B: Create boot disk.
Install:
b: Apply basic settings.
t: Install development tools.
hf: Install Homebrew Formulas.
hc: Install Homebrew Casks.
m: Install Mac App Store software.
a: Install application software.
x: Install application software extensions.
d: Apply default settings.
s: Setup installed software.
i: Install everything (i.e. executes all install options).
Restore:
R: Restore settings from backup.
Manage:
c: Check status of managed software.
C: Caffeinate machine.
ua: Uninstall application software.
ux: Uninstall application software extension.
ra: Reinstall application software.
rx: Reinstall application software extension.
w: Clean work (temp) directory.
q: Quit/Exit.
Choose option `i` to run all install options or select a specific option to run a single option.
Each option is designed to be re-run if necessary. This can also be handy for performing upgrades,
re-running a missing/failed install, etc.
The option prompt can be skipped by passing the desired option directly to the `bin/run` script. For
example, executing `bin/run i` will execute the complete software install process.
The machine should be rebooted after all install tasks have completed to ensure all settings have
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
All executable scripts can be found in the `bin` folder:
- `bin/apply_basic_settings`: Applies basic, initial, settings for setting up a machine. *This is
meant to be customized.*
- `bin/apply_default_settings`: Applies useful system and application defaults. *This is meant to be
customized.*
- `bin/create_boot_disk`: Creates macOS boot disk.
- `bin/install_app_store`: Installs macOS, GUI-based, App Store applications. *This is meant to be
customized.*
- `bin/install_applications`: Installs macOS, GUI-based, non-App Store applications. *This is meant
to be customized.*
- `bin/install_dev_tools`: Installs macOS development tools required by Homebrew.
- `bin/install_extensions`: Installs macOS application extensions and add-ons. *This is meant to be
customized.*
- `bin/install_homebrew_casks`: Installs Homebrew Formulas. *This is meant to be customized.*
- `bin/install_homebrew_formulas`: Installs Homebrew Casks. *This is meant to be customized.*
- `bin/restore_backup`: Restores system/application settings from backup image. *This is meant to be
customized.*
- `bin/run`: The main script and interface for macOS setup.
- `bin/setup_software`: Configures and launches (if necessary) installed software. *This is meant to
be customized.*
The `lib` folder provides the base framework for installing, re-installing, and uninstalling
software. Everything provided via the [macOS Config](https://github.com/bkuhlmann/mac_os-config)
project is built upon the functions found in the `lib` folder. See the
[macOS Config](https://github.com/bkuhlmann/mac_os-config) project for further details.
- `lib/settings.sh`: Defines global settings for software applications, extensions, etc.
## Versioning
Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
- 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
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
Read [CONTRIBUTING](CONTRIBUTING.md) for details.
## License
Copyright (c) 2016 [Alchemists](https://www.alchemists.io).
Read [LICENSE](LICENSE.md) for details.
## History
Read [CHANGES](CHANGES.md) for details.
Built with [Bashsmith](https://github.com/bkuhlmann/bashsmith).
## Credits
Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
[Alchemists](https://www.alchemists.io).

View File

@@ -1,16 +1,13 @@
#! /usr/bin/env bash
# DESCRIPTION
# Applies basic system settings.
# SETTINGS
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/apply_basic_settings"
# EXECUTION
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else

View File

@@ -1,16 +1,13 @@
#! /usr/bin/env bash
# DESCRIPTION
# Applies default settings.
# SETTINGS
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/apply_default_settings"
# EXECUTION
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else

View File

@@ -1,18 +1,17 @@
#! /usr/bin/env bash
# DESCRIPTION
# Creates macOS boot disk.
# EXECUTION
printf "macOS Boot Disk Tips\n"
printf " - Use a USB drive (8GB or higher is best).\n"
printf " - Use Disk Utility to format the USB drive (Use \"Untitled\" for the label).\n"
printf " - Use a USB drive (8GB or higher).\n"
printf " - Use Disk Utility to format the USB drive as \"Mac OS Extended (Journaled)\".\n"
printf " - Use Disk Utility to label the USB drive as \"Untitled\".\n"
printf "\nmacOS Boot Disk Usage:\n"
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. Use Disk Utility to format the machine's drive as \"APFS (Encrypted)\".\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"
@@ -23,8 +22,8 @@ printf " 5. Use the dialog options to launch Disk Utility, reinstall the system
printf "\nCreating macOS boot disk...\n"
if [[ ! -d "$MAC_OS_INSTALLER_PATH" ]]; then
printf "ERROR: macOS installer does not exist: $MAC_OS_INSTALLER_PATH. Use the App Store to download.\n"
if [[ ! -e "$MAC_OS_BOOT_DISK_CREATOR" ]]; then
printf "ERROR: macOS installer does not exist: $MAC_OS_BOOT_DISK_CREATOR. Use System Preferences → Software Update to download.\n"
exit 1
fi
@@ -33,4 +32,4 @@ if [[ ! -d "$MAC_OS_BOOT_DISK_PATH" ]]; then
exit 1
fi
sudo "$MAC_OS_BOOT_DISK_CREATOR" --volume "$MAC_OS_BOOT_DISK_PATH" --applicationpath "$MAC_OS_INSTALLER_PATH" --nointeraction
sudo "$MAC_OS_BOOT_DISK_CREATOR" --volume "$MAC_OS_BOOT_DISK_PATH" --downloadassets --nointeraction

View File

@@ -1,16 +1,13 @@
#! /usr/bin/env bash
# DESCRIPTION
# Installs App Store software.
# SETTINGS
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_app_store"
# EXECUTION
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else

View File

@@ -1,16 +1,13 @@
#! /usr/bin/env bash
# DESCRIPTION
# Installs applications.
# SETTINGS
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_applications"
# EXECUTION
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else

View File

@@ -1,23 +1,13 @@
#! /usr/bin/env bash
# DESCRIPTION
# Installs development tooling requirements.
printf "Installing Xcode CLI tools...\n"
xcode-select --install
printf "%s\n" "💡 ALT+TAB to view and accept Xcode license window."
read -p "Have you completed the Xcode CLI tools install (y/n)? " xcode_response
if [[ "$xcode_response" != "y" ]]; then
printf "ERROR: Xcode CLI tools must be installed before proceeding.\n"
exit 1
fi
printf "Installing $JAVA_LABEL...\n"
printf "%s\n" "You must manually accept the license and download the $JAVA_LABEL: $JAVA_DOWNLOAD_URL."
open $JAVA_DOWNLOAD_URL
read -p "Have you completed the $JAVA_LABEL install (y/n)? " java_response
if [[ "$java_response" != "y" ]]; then
printf "ERROR: $JAVA_LABEL must be installed before proceeding.\n"
exit 1
fi

View File

@@ -1,16 +1,13 @@
#! /usr/bin/env bash
# DESCRIPTION
# Installs application extensions.
# SETTINGS
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_extensions"
# EXECUTION
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else

View File

@@ -1,16 +1,13 @@
#! /usr/bin/env bash
# DESCRIPTION
# Installs Homebrew Cask software.
# SETTINGS
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_homebrew_casks"
# EXECUTION
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else

View File

@@ -1,16 +1,13 @@
#! /usr/bin/env bash
# DESCRIPTION
# Installs Homebrew Formula software.
# SETTINGS
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_homebrew_formulas"
# EXECUTION
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else

View File

@@ -1,16 +1,13 @@
#! /usr/bin/env bash
# DESCRIPTION
# Performs restoration of backup data.
# SETTINGS
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/restore_backup"
# EXECUTION
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else

View File

@@ -1,16 +1,10 @@
#! /usr/bin/env bash
# DESCRIPTION
# Executes the command line interface.
# USAGE
# ./run.sh OPTION
# LIBRARY
source lib/installers.sh
source lib/options.sh
source lib/reinstallers.sh
source lib/restorers.sh
source lib/settings.sh
source lib/uninstallers.sh
source lib/utilities.sh
@@ -29,7 +23,6 @@ else
exit 1
fi
# EXECUTION
while true; do
if [[ $# == 0 ]]; then
printf "\nUsage: run OPTION\n"

View File

@@ -1,16 +1,13 @@
#! /usr/bin/env bash
# DESCRIPTION
# Sets up and launches (if necessary) installed software.
# SETTINGS
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/setup_software"
# EXECUTION
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else

View File

@@ -1,7 +1,61 @@
dependencies:
pre:
- gem update --system
- gem update bundler
test:
override:
- bundle exec rake
version: 2
jobs:
build:
working_directory: ~/project
docker:
- image: circleci/ruby
environment:
BUNDLE_JOBS: 3
BUNDLE_RETRY: 3
BUNDLE_PATH: vendor/bundle
EDITOR: vim
steps:
- checkout
- run:
name: Environment Setup
command: |
printf "%s\n" 'export CI_RUBY_VERSION=$(cat ".ruby-version" | tr -d "\n")' >> $BASH_ENV
- type: cache-restore
name: Ruby Restore
key: ruby-{{checksum ".ruby-version"}}
- run:
name: Ruby Install
command: |
curl https://cache.ruby-lang.org/pub/ruby/${CI_RUBY_VERSION::-2}/ruby-$CI_RUBY_VERSION.tar.bz2 > ../ruby-$CI_RUBY_VERSION.tar.gz
cd ..
tar --extract --bzip2 --verbose --file ruby-$CI_RUBY_VERSION.tar.gz
cd ruby-$CI_RUBY_VERSION
./configure
make
make update-gems
make extract-gems
sudo make install
- type: cache-save
name: Ruby Store
key: ruby-{{checksum ".ruby-version"}}
paths:
- ../ruby-$CI_RUBY_VERSION
- type: cache-restore
name: Bundler Restore
key: bundler-{{checksum "Gemfile"}}
- run:
name: Bundler Install
command: |
gem update --system
bundle install --path vendor/bundle
- type: cache-save
name: Bundler Store
key: bundler-{{checksum "Gemfile"}}
paths:
- vendor/bundle
- run:
name: Build
command: bundle exec rake

View File

@@ -1,149 +1,19 @@
#! /usr/bin/env bash
# DESCRIPTION
# Defines software installer functions.
# Mounts a disk image.
# Parameters:
# $1 = The image path.
mount_image() {
printf "Mounting image...\n"
hdiutil attach -quiet -nobrowse -noautoopen "$1"
}
export -f mount_image
# Unmounts a disk image.
# Parameters:
# $1 = The mount path.
unmount_image() {
printf "Unmounting image...\n"
hdiutil detach -force "$1"
}
export -f unmount_image
# Downloads an installer to local disk.
# Parameters:
# $1 = The URL.
# $2 = The file name.
# $3 = The HTTP header.
download_installer() {
local url="$1"
local file_name="$2"
local http_header="$3"
printf "%s\n" "Downloading $1..."
clean_work_path
mkdir $MAC_OS_WORK_PATH
curl --header "$http_header" --location --retry 3 --retry-delay 5 --fail --silent --show-error "$url" >> "$MAC_OS_WORK_PATH/$file_name"
}
export -f download_installer
# Downloads an installer to the $HOME/Downloads folder for manual use.
# Parameters:
# $1 = The URL.
# $2 = The file name.
download_only() {
if [[ -e "$HOME/Downloads/$2" ]]; then
printf "Downloaded: $2.\n"
else
printf "Downloading $1...\n"
download_installer "$1" "$2"
mv "$MAC_OS_WORK_PATH/$2" "$HOME/Downloads"
fi
}
export -f download_only
# Installs a single file.
# Parameters:
# $1 = The URL.
# $2 = The install path.
install_file() {
local file_url="$1"
local file_name=$(get_file_name "$1")
local install_path="$2"
if [[ ! -e "$install_path" ]]; then
printf "Installing: $install_path...\n"
download_installer "$file_url" "$file_name"
mkdir -p $(dirname "$install_path")
mv "$MAC_OS_WORK_PATH/$file_name" "$install_path"
printf "Installed: $file_name.\n"
verify_path "$install_path"
fi
}
export -f install_file
# Installs an application.
# Parameters:
# $1 = The application source path.
# $2 = The application name.
install_app() {
local install_root=$(get_install_root "$2")
local file_extension=$(get_file_extension "$2")
printf "Installing: $install_root/$2...\n"
case $file_extension in
'app')
cp -a "$1/$2" "$install_root";;
'prefPane')
sudo cp -pR "$1/$2" "$install_root";;
'qlgenerator')
sudo cp -pR "$1/$2" "$install_root" && qlmanage -r;;
*)
printf "ERROR: Unknown file extension: $file_extension.\n"
esac
}
export -f install_app
# Installs a package.
# Parameters:
# $1 = The package source path.
# $2 = The application name.
install_pkg() {
local install_root=$(get_install_root "$2")
printf "Installing: $install_root/$2...\n"
local package=$(sudo find "$1" -maxdepth 1 -type f -name "*.pkg" -o -name "*.mpkg")
sudo installer -pkg "$package" -target /
}
export -f install_pkg
# Installs Java.
# Parameters:
# $1 = The URL.
# $2 = The volume name.
install_java() {
local url="$1"
local volume_path="/Volumes/$2"
local app_name="java"
local install_path="/usr/bin/$app_name"
local download_file="download.dmg"
download_installer "$url" "$download_file" "Cookie: oraclelicense=accept-securebackup-cookie"
mount_image "$MAC_OS_WORK_PATH/$download_file"
local package=$(sudo find "$volume_path" -maxdepth 1 -type f -name "*.pkg")
sudo installer -pkg "$package" -target /
unmount_image "$volume_path"
printf "Installed: $app_name.\n"
}
export -f install_java
# Installs an application via a DMG file.
# Parameters:
# $1 = The URL.
# $2 = The mount path.
# $3 = The application name.
# Parameters: $1 (required) - URL, $2 (required) - Mount path, $3 (required) - Application name.
install_dmg_app() {
local url="$1"
local mount_point="/Volumes/$2"
local app_name="$3"
local install_path=$(get_install_path "$app_name")
local download_file="download.dmg"
local work_file="download.dmg"
if [[ ! -e "$install_path" ]]; then
download_installer "$url" "$download_file"
mount_image "$MAC_OS_WORK_PATH/$download_file"
download_file "$url" "$work_file"
mount_image "$MAC_OS_WORK_PATH/$work_file"
install_app "$mount_point" "$app_name"
unmount_image "$mount_point"
verify_application "$app_name"
@@ -152,20 +22,17 @@ install_dmg_app() {
export -f install_dmg_app
# Installs a package via a DMG file.
# Parameters:
# $1 = The URL.
# $2 = The mount path.
# $3 = The application name.
# Parameters: $1 (required) - URL, $2 (required) - Mount path, $3 (required) - Application name.
install_dmg_pkg() {
local url="$1"
local mount_point="/Volumes/$2"
local app_name="$3"
local install_path=$(get_install_path "$app_name")
local download_file="download.dmg"
local work_file="download.dmg"
if [[ ! -e "$install_path" ]]; then
download_installer "$url" "$download_file"
mount_image "$MAC_OS_WORK_PATH/$download_file"
download_file "$url" "$work_file"
mount_image "$MAC_OS_WORK_PATH/$work_file"
install_pkg "$mount_point" "$app_name"
unmount_image "$mount_point"
printf "Installed: $app_name.\n"
@@ -175,22 +42,20 @@ install_dmg_pkg() {
export -f install_dmg_pkg
# Installs an application via a zip file.
# Parameters:
# $1 = The URL.
# $2 = The application name.
# Parameters: $1 (required) - URL, $2 (required) - Application name.
install_zip_app() {
local url="$1"
local app_name="$2"
local install_path=$(get_install_path "$app_name")
local download_file="download.zip"
local work_file="download.zip"
if [[ ! -e "$install_path" ]]; then
download_installer "$url" "$download_file"
download_file "$url" "$work_file"
(
printf "Preparing...\n"
cd "$MAC_OS_WORK_PATH"
unzip -q "$download_file"
unzip -q "$work_file"
find . -type d -name "$app_name" -print -exec cp -pR {} . > /dev/null 2>&1 \;
)
@@ -201,51 +66,21 @@ install_zip_app() {
}
export -f install_zip_app
# Installs an application via a tar file.
# Parameters:
# $1 = The URL.
# $2 = The application name.
# $3 = The decompress options.
install_tar_app() {
local url="$1"
local app_name="$2"
local options="$3"
local install_path=$(get_install_path "$app_name")
local download_file="download.tar"
if [[ ! -e "$install_path" ]]; then
download_installer "$url" "$download_file"
(
printf "Preparing...\n"
cd "$MAC_OS_WORK_PATH"
tar "$options" "$download_file"
)
install_app "$MAC_OS_WORK_PATH" "$app_name"
printf "Installed: $app_name.\n"
verify_application "$app_name"
fi
}
export -f install_tar_app
# Installs a package via a zip file.
# Parameters:
# $1 = The URL.
# $2 = The application name.
# Parameters: $1 (required) - URL, $2 (required) - Application name.
install_zip_pkg() {
local url="$1"
local app_name="$2"
local install_path=$(get_install_path "$app_name")
local download_file="download.zip"
local work_file="download.zip"
if [[ ! -e "$install_path" ]]; then
download_installer "$url" "$download_file"
download_file "$url" "$work_file"
(
printf "Preparing...\n"
cd "$MAC_OS_WORK_PATH"
unzip -q "$download_file"
unzip -q "$work_file"
)
install_pkg "$MAC_OS_WORK_PATH" "$app_name"
@@ -255,11 +90,50 @@ install_zip_pkg() {
}
export -f install_zip_pkg
# Installs an application via a tar file.
# Parameters: $1 (required) - URL, $2 (required) - Application name, $3 (required) - Decompress options.
install_tar_app() {
local url="$1"
local app_name="$2"
local options="$3"
local install_path=$(get_install_path "$app_name")
local work_file="download.tar"
if [[ ! -e "$install_path" ]]; then
download_file "$url" "$work_file"
(
printf "Preparing...\n"
cd "$MAC_OS_WORK_PATH"
tar "$options" "$work_file"
)
install_app "$MAC_OS_WORK_PATH" "$app_name"
printf "Installed: $app_name.\n"
verify_application "$app_name"
fi
}
export -f install_tar_app
# Installs program (single file).
# Parameters: $1 (required) - URL, $2 (required) - Program name.
install_program() {
local url="$1"
local program_name="$2"
local install_path=$(get_install_path "$program_name")
if [[ ! -e "$install_path" ]]; then
download_file "$url" "$program_name"
mv "$MAC_OS_WORK_PATH/$program_name" "$install_path"
chmod 755 "$install_path"
printf "Installed: $program_name.\n"
verify_application "$program_name"
fi
}
export -f install_program
# Installs application code from a Git repository.
# Parameters:
# $1 = Repository URL.
# $2 = Install path.
# $3 = Git clone options (if any).
# Parameters: $1 (required) - Repository URL, $2 (required) - Install path, $3 (optional) - Git clone options.
install_git_app() {
local repository_url="$1"
local app_name=$(get_file_name "$2")
@@ -280,11 +154,7 @@ install_git_app() {
export -f install_git_app
# Installs settings from a Git repository.
# Parameters:
# $1 = The repository URL.
# $2 = The repository version.
# $3 = The project directory.
# $4 = The script to run (including any arguments).
# Parameters: $1 (required) - Repository URL, $2 (required) - Repository version, $3 (required) - Project directory, $4 (required) - Script to run (including any arguments).
install_git_project() {
local repo_url="$1"
local repo_version="$2"
@@ -294,9 +164,90 @@ install_git_project() {
git clone "$repo_url"
(
cd "$project_dir"
git checkout "$repo_version"
git -c advice.detachedHead=false checkout "$repo_version"
eval "$script"
)
rm -rf "$project_dir"
}
export -f install_git_project
# Installs a single file.
# Parameters: $1 (required) - URL, $2 (required) - Install path.
install_file() {
local file_url="$1"
local file_name=$(get_file_name "$1")
local install_path="$2"
if [[ ! -e "$install_path" ]]; then
download_file "$file_url" "$file_name"
mkdir -p $(dirname "$install_path")
mv "$MAC_OS_WORK_PATH/$file_name" "$install_path"
printf "Installed: $file_name.\n"
verify_path "$install_path"
fi
}
export -f install_file
# Downloads remote file to local disk.
# Parameters: $1 (required) - URL, $2 (required) - File name, $3 (optional) - HTTP header.
download_file() {
local url="$1"
local file_name="$2"
local http_header="$3"
printf "%s\n" "Downloading $1..."
clean_work_path
mkdir $MAC_OS_WORK_PATH
curl --header "$http_header" --location --retry 3 --retry-delay 5 --fail --silent --show-error "$url" >> "$MAC_OS_WORK_PATH/$file_name"
}
export -f download_file
# Installs an application.
# Parameters: $1 (required) - Application source path, $2 (required) - Application name.
install_app() {
local install_root=$(get_install_root "$2")
local file_extension=$(get_file_extension "$2")
printf "Installing: $install_root/$2...\n"
case $file_extension in
'')
cp -a "$1/$2" "$install_root";;
'app')
cp -a "$1/$2" "$install_root";;
'prefPane')
sudo cp -pR "$1/$2" "$install_root";;
'qlgenerator')
sudo cp -pR "$1/$2" "$install_root" && qlmanage -r;;
*)
printf "ERROR: Unknown file extension: $file_extension.\n"
esac
}
export -f install_app
# Installs a package.
# Parameters: $1 (required) - Package source path, $2 (required) - Application name.
install_pkg() {
local install_root=$(get_install_root "$2")
printf "Installing: $install_root/$2...\n"
local package=$(sudo find "$1" -maxdepth 1 -type f -name "*.pkg" -o -name "*.mpkg")
sudo installer -pkg "$package" -target /
}
export -f install_pkg
# Mounts a disk image.
# Parameters: $1 (required) - Image path.
mount_image() {
printf "Mounting image...\n"
hdiutil attach -quiet -nobrowse -noautoopen "$1"
}
export -f mount_image
# Unmounts a disk image.
# Parameters: $1 (required) - Mount path.
unmount_image() {
printf "Unmounting image...\n"
hdiutil detach -force "$1"
}
export -f unmount_image

View File

@@ -1,11 +1,9 @@
#! /usr/bin/env bash
# DESCRIPTION
# Defines command line prompt options.
# Process option selection.
# Parameters:
# $1 = The option to process.
# Parameters: $1 (required) - The option to process.
process_option() {
case $1 in
'B')
@@ -43,7 +41,9 @@ process_option() {
'R')
bin/restore_backup;;
'c')
verify_homebrews
verify_homebrew_formulas
verify_homebrew_casks
verify_app_store_applications
verify_applications
verify_extensions;;
'C')

View File

@@ -1,6 +1,5 @@
#! /usr/bin/env bash
# DESCRIPTION
# Defines reinstall functions.
# Reinstall application.

View File

@@ -1,31 +0,0 @@
#! /usr/bin/env bash
# DESCRIPTION
# Defines software restore functions.
# Label: Restore Preference
# Description: Restores an application preference.
# Parameters: $1 (required) - The backup volume root path, $2 (required) - The preference file.
restore_preference() {
local backup_root="$1"
local preference_file="$2"
local backup_path="$backup_root/Users/$USER/Library/Preferences/$preference_file"
local restore_root="$HOME/Library/Preferences"
cp -p "$backup_path" "$restore_root"
}
export -f restore_preference
# Label: Restore Application Support
# Description: Restores application support files.
# Parameters: $1 (required) - The backup volume root path, $2 required - The application name.
restore_app_support() {
local backup_root="$1"
local app_name="$2"
local backup_path="$backup_root/Users/$USER/Library/Application Support/$app_name"
local restore_path="$HOME/Library/Application Support"
mkdir -p "$restore_path"
cp -pR "$backup_path" "$restore_path"
}
export -f restore_app_support

View File

@@ -1,22 +1,11 @@
#! /usr/bin/env bash
# DESCRIPTION
# Defines global settings.
# SETTINGS
# General
set -o nounset
set -o errexit
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 Catalina.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_WORK_PATH=/tmp/downloads
export MAC_OS_CONFIG_PATH="../mac_os-config"
# Java
export JAVA_LABEL="Java SE Development Kit"
export JAVA_DOWNLOAD_URL="http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html"

View File

@@ -1,6 +1,5 @@
#! /usr/bin/env bash
# DESCRIPTION
# Defines uninstall functions.
# Uninstalls selected application.

View File

@@ -1,34 +1,37 @@
#! /usr/bin/env bash
# DESCRIPTION
# Defines general utility functions.
# Answers the file name.
# Parameters:
# $1 = The file path.
get_file_name() {
printf "${1##*/}" # Answers file or directory name.
# Answers the full install path (including file name) for file name.
# Parameters: $1 (required) - The file name.
get_install_path() {
local file_name="$1"
local install_path=$(get_install_root "$file_name")
printf "$install_path/$file_name"
}
export -f get_file_name
export -f get_install_path
# Answers the file extension.
# Parameters:
# $1 = The file name.
get_file_extension() {
local name=$(get_file_name "$1")
local extension="${1##*.}" # Excludes dot.
# Cleans work path for temporary processing of installs.
clean_work_path() {
rm -rf "$MAC_OS_WORK_PATH"
}
export -f clean_work_path
if [[ "$name" == "$extension" ]]; then
printf ''
# Caffeinate machine.
caffeinate_machine() {
local pid=$(pgrep -x caffeinate)
if [[ -n "$pid" ]]; then
printf "Whoa, tweaker, machine is already caffeinated!\n"
else
printf "$extension"
caffeinate -s -u -d -i -t 3153600000 > /dev/null &
printf "Machine caffeinated.\n"
fi
}
export -f get_file_extension
export -f caffeinate_machine
# Answers the root install path for file name.
# Parameters:
# $1 = The file name.
# Parameters: $1 (required) - The file name.
get_install_root() {
local file_name="$1"
local file_extension=$(get_file_extension "$file_name")
@@ -49,31 +52,23 @@ get_install_root() {
}
export -f get_install_root
# Answers the full install path (including file name) for file name.
# Parameters:
# $1 = The file name.
get_install_path() {
local file_name="$1"
local install_path=$(get_install_root "$file_name")
printf "$install_path/$file_name"
}
export -f get_install_path
# Answers the file extension.
# Parameters: $1 (required) - The file name.
get_file_extension() {
local name=$(get_file_name "$1")
local extension="${1##*.}" # Excludes dot.
# Cleans work path for temporary processing of installs.
clean_work_path() {
rm -rf "$MAC_OS_WORK_PATH"
}
export -f clean_work_path
# Caffeinate machine.
caffeinate_machine() {
local pid=$(ps aux | grep caffeinate | grep -v grep | awk '{print $2}')
if [[ -n "$pid" ]]; then
printf "Whoa, tweaker, machine is already caffeinated!\n"
if [[ "$name" == "$extension" ]]; then
printf ''
else
caffeinate -s -u -d -i -t 3153600000 > /dev/null &
printf "Machine caffeinated.\n"
printf "$extension"
fi
}
export -f caffeinate_machine
export -f get_file_extension
# Answers the file name.
# Parameters: $1 (required) - The file path.
get_file_name() {
printf "${1##*/}" # Answers file or directory name.
}
export -f get_file_name

View File

@@ -1,24 +1,10 @@
#! /usr/bin/env bash
# DESCRIPTION
# Defines verification/validation functions.
# Verifies Homebrew software exists.
# Parameters:
# $1 = The file name.
verify_homebrew() {
local application="$1"
local applications="$2"
if [[ "${applications[*]}" != *"$application"* ]]; then
printf " - Missing: $application\n"
fi
}
export -f verify_homebrew
# Checks for missing Homebrew software.
verify_homebrews() {
printf "Checking Homebrew software...\n"
# Checks for missing Homebrew formulas.
verify_homebrew_formulas() {
printf "Checking Homebrew formulas...\n"
local applications="$(brew list)"
@@ -37,28 +23,72 @@ verify_homebrews() {
application="mercurial"
fi
verify_homebrew "$application" "${applications[*]}"
verify_listed_application "$application" "${applications[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew"
done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew_formulas"
printf "Homebrew check complete.\n"
printf "Homebrew formula check complete.\n"
}
export -f verify_homebrews
export -f verify_homebrew_formulas
# Verifies application exists.
# Parameters:
# $1 = The file name.
verify_application() {
local file_name="$1"
# Checks for missing Homebrew casks.
verify_homebrew_casks() {
printf "\nChecking Homebrew casks...\n"
# Display the missing install if not found.
local install_path=$(get_install_path "$file_name")
local applications="$(brew cask list)"
if [[ ! -e "$install_path" ]]; then
printf " - Missing: $file_name\n"
while read line; do
# Skip blank or comment lines.
if [[ "$line" == "brew cask install"* ]]; then
local application=$(printf "$line" | awk '{print $4}')
# Skip: Only necessary for the purpose of licensing system preference.
if [[ "$application" == "witch" ]]; then
continue
fi
# Skip: Bug with Homebrew Cask as these apps never show up as installed.
if [[ "$application" == "skitch" || "$application" == "openemu" ]]; then
continue
fi
verify_listed_application "$application" "${applications[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew_casks"
printf "Homebrew cask check complete.\n"
}
export -f verify_homebrew_casks
# Checks for missing App Store applications.
verify_app_store_applications() {
printf "\nChecking App Store applications...\n"
local applications="$(mas list)"
while read line; do
# Skip blank or comment lines.
if [[ "$line" == "mas install"* ]]; then
local application=$(printf "$line" | awk '{print $3}')
verify_listed_application "$application" "${applications[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_app_store"
printf "App Store check complete.\n"
}
export -f verify_app_store_applications
# Verifies listed application exists.
# Parameters: $1 (required) - The current application, $2 (required) - The application list.
verify_listed_application() {
local application="$1"
local applications="$2"
if [[ "${applications[*]}" != *"$application"* ]]; then
printf " - Missing: $application\n"
fi
}
export -f verify_application
export -f verify_listed_application
# Checks for missing applications suffixed by "APP_NAME" as defined in settings.sh.
verify_applications() {
@@ -77,18 +107,19 @@ verify_applications() {
}
export -f verify_applications
# Verifies path exists.
# Parameters:
# $1 = The path.
verify_path() {
local path="$1"
# Verifies application exists.
# Parameters: $1 (required) - The file name.
verify_application() {
local file_name="$1"
# Display the missing path if not found.
if [[ ! -e "$path" ]]; then
printf " - Missing: $path\n"
# Display the missing install if not found.
local install_path=$(get_install_path "$file_name")
if [[ ! -e "$install_path" ]]; then
printf " - Missing: $file_name\n"
fi
}
export -f verify_path
export -f verify_application
# Checks for missing extensions suffixed by "EXTENSION_PATH" as defined in settings.sh.
verify_extensions() {
@@ -106,3 +137,15 @@ verify_extensions() {
printf "Application extension check complete.\n"
}
export -f verify_extensions
# Verifies path exists.
# Parameters: $1 (required) - The path.
verify_path() {
local path="$1"
# Display the missing path if not found.
if [[ ! -e "$path" ]]; then
printf " - Missing: $path\n"
fi
}
export -f verify_path