Compare commits

..

61 Commits

Author SHA1 Message Date
Brooke Kuhlmann
029fce45b4 Added version release notes 2021-07-17 11:44:05 -06:00
Brooke Kuhlmann
e9d1928b90 Updated to Ruby 3.0.2
Necessary to address security fixes. [Details](https://chl.li/J2u5O).
2021-07-07 13:29:28 -06:00
Brooke Kuhlmann
14394e5c51 Updated to Ruby 3.0.1
Necessary to account for a couple of security vulnerabilities with temp
path and the REXML library.
2021-04-05 17:58:32 -06:00
Brooke Kuhlmann
566b9d871e Added version release notes 2021-03-16 18:22:22 -06:00
Brooke Kuhlmann
f640e37089 Updated setup software as configure software script
Necessary to better describe the purpose of this script.
2021-03-16 18:21:28 -06:00
Brooke Kuhlmann
c3c3036c88 Added dotfiles script
Necessary to make installing personal dotfiles a first class citizen
like many of the other install scripts. Having one's own dotfiles as
part of the machine setup helps ensure the shell is configured properly
especially when it comes to dealing with language specific dependencies
for Ruby, Rust, Node, etc. This reduces duplication within this project
-- and the macOS Configuration project -- from having to know all of
these details when settings can be defined within one's own dotfiles
once.
2021-03-16 18:21:18 -06:00
Brooke Kuhlmann
6990b9d2c6 Added Node packages script
Necessary to provide a single source of truth for installing Node
dependencies. This used to be managed by the Yarn Setup project but
that project is being deprecated in favor of this project.
2021-03-16 18:21:09 -06:00
Brooke Kuhlmann
b8d96b3479 Fixed environment configuration to source Bash resource
Once the `.bashrc` file has been created, immediately load it so
contents are executed instead of duplicating this work on a separate
line.
2021-03-16 18:21:06 -06:00
Brooke Kuhlmann
be9edafe52 Added Ruby gems script
Necessary to provide a single source of truth for installing Ruby
dependencies. This used to be managed by the Ruby Setup project but
that project is being deprecated in favor of this project.
2021-03-16 18:20:57 -06:00
Brooke Kuhlmann
c62ef77ce2 Updated install root detection to support Elm
Necessary so Elm can be installed properly since Homebrew support isn't
great.
2021-03-16 18:20:57 -06:00
Brooke Kuhlmann
e9cd22bb36 Added bare package installer
Necessary to download and install bare packages that are not wrapped as
DMGs or zips first.
2021-03-16 18:20:57 -06:00
Brooke Kuhlmann
e9476d6a6a Refactored install scripts to separate script paths
Minor improvement to readability so the script path stands out as being
configuragble versus being grouped with the default Bash settings.
2021-03-16 18:20:57 -06:00
Brooke Kuhlmann
35663cf8b3 Added Rust crates script
Necessary to implement the installation of Rust and associated crates
which can be used by downstream configurations. This functionality was
originally part of the macOS Configuration project but has been moved
here to provide a common foundation in which to build upon.
2021-03-16 18:20:44 -06:00
Brooke Kuhlmann
eec175e232 Added mas check to App Store install script
Necessary to ensure mas is installed before executing the script. This
reduces the strain on downstream projects/scripts from having to do
this check. This was previously part of the macOS Configuration project
but has been moved here as central location for core functionality.
2021-03-14 11:24:12 -06:00
Brooke Kuhlmann
dd62dad160 Added Homebrew installation to Homebrew sripts
Ensures Homebrew is installed before running scripts so downstream
projects don't have to remember to do this work.
2021-03-14 11:11:11 -06:00
Brooke Kuhlmann
c65f06d5b8 Removed CPU detection in favor of architecture detection
Provides a cleaner and more reliable way to determine what machine
architecture is being used.
2021-02-28 09:10:42 -07:00
Brooke Kuhlmann
6567969919 Updated dev tools installer to agree to Rosetta license
Necessary to reduce an additional prompt for the user to deal with and
allow a more automated install process. This also includes better
architecture detection, instead of CPU detection, when determining
whether to install Rosetta.
2021-02-28 09:09:27 -07:00
Brooke Kuhlmann
82d50299c7 Added version release notes 2021-02-27 15:36:46 -07:00
Brooke Kuhlmann
ec441aefef Added environment configuration for scripts
Necessary to ensure machines are properly configured for running these
scripts on either Apple Silicon or Intel based machines.
2021-02-27 11:24:57 -07:00
Brooke Kuhlmann
e4ef33a5f6 Added Rosetta to development tools install script
Necessary for Apple Silicon machines -- at least for the time being --
in order to translate Intel based programs that are not ready to run
natively of Silicon hardware yet.
2021-02-27 11:24:57 -07:00
Brooke Kuhlmann
eaefe9fa04 Added Homebrew install function
Necessary to define the installation of Homebrew via a single function.
This was originally part of the macOS Configuration project but is now
located here instead.
2021-02-27 11:24:57 -07:00
Brooke Kuhlmann
71da0e7b1b Added Homebrew utility path functions
Necessary to compute the correct Homebrew paths for both Silicon and
Intel based machines.
2021-02-27 11:24:57 -07:00
Brooke Kuhlmann
2c518d797e Added CPU utility function
Necessary for answering CPU of current machine when determining what
kind of functionality should be used when executing scripts on Silicon
or Intel based hardware. In this case, it'll answers "M1" when using an
Apple Silicon chip. For Intel based machines, nothing will be answered
since they use multiple "Processor" fields.
2021-02-22 20:10:12 -07:00
Brooke Kuhlmann
5e25c8d3f9 Refactored utility functions to be alphabetically sorted
Speeds up function lookup within the source code.
2021-02-21 12:57:50 -07:00
Brooke Kuhlmann
3aea499672 Refactored verifier functions to be alphabetically sorted
Speeds up function lookup within the source code.
2021-02-21 12:56:21 -07:00
Brooke Kuhlmann
0ddd9b0986 Refactored installer functions to be alphabetically sorted
Speeds up lookup for each function.
2021-02-21 12:52:49 -07:00
Brooke Kuhlmann
5a4d45ffed Added Apple Silicon instructions
Necessary to support the new Apple Silicon (M1) chips and older
Intel-based systems.
2021-02-20 09:43:01 -07:00
Brooke Kuhlmann
cb3ed0108d Updated to Docker Alpine Ruby image
Provides a smaller footprint for testing Ruby code.
2021-02-13 09:53:02 -07:00
Brooke Kuhlmann
8c4c734043 Updated to Circle CI 2.1.0
Necessary to pick up the new syntax, configuration location, and custom
Docker image.
2021-01-23 17:50:00 -07:00
Brooke Kuhlmann
160447eda3 Added version release notes 2021-01-10 10:42:35 -07:00
Brooke Kuhlmann
803c38e1c2 Updated boot disk recovery documentation
Improves labeling and categorization consistency while also cleaning up
some of the README terminology.

The recovery option is more of a last resort, provided by Apple, should
something catastrophic happen with the boot disk.
2021-01-10 10:36:09 -07:00
Brooke Kuhlmann
76432f5a74 Fixed brew formulae list error
Resolves the following from happening:

    Error: Calling `brew list` to only list formulae is disabled! Use
    `brew list --formula` instead.

Includes a correction for the plural form for `casks` as well.
2021-01-04 19:31:40 -07:00
Brooke Kuhlmann
85c85a5e80 Added version release notes 2021-01-03 16:49:15 -07:00
Brooke Kuhlmann
b83ecf6516 Removed README Startup Security Utility documentation
Added to the macOS Configuration project, instead, since it makes more
sense to keep all pre and post install steps together in one place.
2021-01-03 14:41:57 -07:00
Brooke Kuhlmann
3889930672 Added caffeination to restore process
Restoration from backup can take a while so this ensures the machine
doesn't go to sleep during this process.
2021-01-03 14:41:16 -07:00
Brooke Kuhlmann
856f51422a Updated troubleshooting documentation
Focuses on issues experienced related to the macOS Big Sur upgrade.
2021-01-03 14:31:16 -07:00
Brooke Kuhlmann
433ad04028 Updated boot disk instructions for main disk format
Necessary because installation of Big Sur doesn't seem to like password
protected APFS drives. Disk encryption will have to happen after
installation via FileVault.
2021-01-03 14:31:15 -07:00
Brooke Kuhlmann
605190577f Added version release notes 2020-12-30 10:31:46 -07:00
Brooke Kuhlmann
c9c7f46e4a Updated to Git Lint 2.0.0
Supports Ruby 3.0.0.

[Details](https://www.alchemists.io/projects/git-lint/changes.html).
2020-12-29 19:33:36 -07:00
Brooke Kuhlmann
f8a779e926 Updated to Ruby 3.0.0
Includes temporary disablement of gem dependencies that require
updating to Ruby 3.0.0 first.

[Details](https://chl.li/LdWrE).
2020-12-29 10:35:38 -07:00
Brooke Kuhlmann
e6f991baca Added Circle CI explicit Bundle install configuration
Due to fixing the `vendor/bundle` path earlier (see previous commit),
we need to be explicit with the installation of gems now.
2020-12-20 07:15:38 -07:00
Brooke Kuhlmann
ae6ab46fa7 Fixed Circle CI configuration for Bundler config path
Prevents the following deprecation warning:

    [DEPRECATED] The `--path` flag is deprecated because it relies on
    being remembered across bundler invocations, which bundler will no
    longer do in future versions. Instead please use `bundle config set
    path 'vendor/bundle'`, and stop using this flag.
2020-12-19 17:10:44 -07:00
Brooke Kuhlmann
45a6c5d1b0 Added version release notes 2020-11-15 07:38:09 -07:00
Brooke Kuhlmann
1bb6ef39a5 Added macOS Big Sur support
Necessary to support the latest macOS release.
2020-11-15 07:35:58 -07:00
Brooke Kuhlmann
1416aa2f0a Updated to Git Lint 1.3.0
[Changes](https://www.alchemists.io/projects/git-lint/changes.html).
2020-11-14 17:37:33 -07:00
Brooke Kuhlmann
b6cddae599 Updated project documentation to conform to Rubysmith template
Necessary to match consistency used by the
[Rubysmith](https://www.alchemists.io/projects/rubysmith) when
building/maintaining projects.
2020-10-13 20:07:16 -06:00
Brooke Kuhlmann
e533bf04be Updated to Ruby 2.7.2
Fixes a WEBrick security flaw but also disables deprecation warnings by
default which is sad to see. We'll have to enable these ourselves if we
want to have an early warning sign of future breaking changes. 😢

[Release Notes](https://chl.li/lLaOn)
2020-10-03 08:27:07 -06:00
Brooke Kuhlmann
5455a76d14 Added version release notes 2020-09-12 10:11:23 -06:00
Brooke Kuhlmann
5569fdb345 Refactored utility basename and extension utilities
Minor cleanup to the method names used for less typing.
2020-09-12 09:58:53 -06:00
Brooke Kuhlmann
8f2173c938 Removed unnecessary verifier code comments
These were not adding much value so are safe to remove.
2020-09-12 09:51:40 -06:00
Brooke Kuhlmann
4f1ed26934 Removed Homebrew Mecurial formula verification check
No longer necessary as Mecurial isn't used or required by any
applications in the macOS Configuration project.
2020-09-12 09:45:27 -06:00
Brooke Kuhlmann
b7c89266f6 Fixed Homebrew cask verifier deprecation warning
Resolves the following warning when using Homebrew 2.5.0:

    Warning: Calling brew cask list is deprecated! Use brew list

Removed conditional checks for the Skitch, Witch, and OpenEmu
applications since they are no longer supported.
2020-09-12 09:45:27 -06:00
Brooke Kuhlmann
09025fd976 Added version release notes 2020-07-22 20:15:48 -06:00
Brooke Kuhlmann
a97de70b65 Updated README screencast cover to SVG format
Replaces PNG in favor of SVG for faster loading and smaller memory
footprint.
2020-07-16 19:15:37 -06:00
Brooke Kuhlmann
1d75357a18 Fixed project requirements
Links were updated and version information was dropped in order to
specify the bare minimum requirements and reduce situations where the
documentation might not always be up-to-date with the *exact* version
being used.
2020-06-20 08:18:46 -06:00
Brooke Kuhlmann
3c78a1cbf0 Refactored Rakefile requirements
Turns out the rescue block wasn't providing a lot of additional aid as
the Bundler and Rake errors are sufficient. By removing this block, the
error output remains clear and improves readability.
2020-06-18 07:14:35 -06:00
Brooke Kuhlmann
3158d024df Updated to Git Lint 1.0.0
It is necessary to drop Git Cop because it has been deprecated. [Git
Lint](https://www.alchemists.io/projects/git-lint) is the new offical
gem for analyzing Git commit quality.
2020-06-13 15:47:00 -06:00
Brooke Kuhlmann
62295d0851 Updated GitHub templates
Provides more clarity on the format desired when opening up an issue or
a pull request. The order of sections was rearranged to focus on the
*why* and *what* of the root issue.

Optional sections remain encouraged but are not required.
2020-06-13 09:24:27 -06:00
Brooke Kuhlmann
34f7dad25d Fixed screencast image URL
The URL was being built incorrectly originally but is now fixed.
2020-04-04 15:09:07 -06:00
Brooke Kuhlmann
e8101bbb3b Updated README screencast URL
Necessary to point to new URL which doesn't force the HTML format (will
provide more flexibility in the future).
2020-04-03 11:40:07 -06:00
Brooke Kuhlmann
3f9eaf969d Updated README credit URL
Necessary to pick up new author profile URL.
2020-04-03 11:32:44 -06:00
33 changed files with 766 additions and 485 deletions

31
.circleci/config.yml Normal file
View File

@@ -0,0 +1,31 @@
version: 2.1
jobs:
build:
working_directory: ~/project
docker:
- image: bkuhlmann/alpine-ruby:latest
steps:
- checkout
- restore_cache:
name: Bundler Restore
keys:
- gem-cache-{{.Branch}}-{{checksum "Gemfile"}}
- gem-cache-
- run:
name: Bundler Install
command: |
gem update --system
bundle config set path "vendor/bundle"
bundle install
- save_cache:
name: Bundler Store
key: gem-cache-{{.Branch}}-{{checksum "Gemfile"}}
paths:
- vendor/bundle
- run:
name: Build
command: bundle exec rake

View File

@@ -1,11 +1,14 @@
## Overview
<!-- Required. Describe, in detail, the behavior experienced and what is desired. -->
## Steps to Recreate
<!-- Optional. List exact steps (numbered list) to reproduce errant behavior. Delete if unused. -->
<!-- Required. Describe, briefly, the behavior experienced. -->
## Screenshots/Screencasts
<!-- Optional. Attach screenshot/screencast(s) that demo the behavior. Delete if unused. -->
<!-- Optional. Attach screenshot(s) and/or screencast(s) that demo the behavior. -->
## Steps to Recreate
<!-- Required. List exact steps (numbered list) to reproduce errant behavior. -->
## Desired Behavior
<!-- Required. Describe the behavior you'd like to see or your idea of a proposed solution. -->
## Environment
<!-- Optional. What is your operating system, software version(s), etc. Delete if unused. -->
<!-- Required. What is your operating system, software version(s), etc. -->

View File

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

View File

@@ -1 +1 @@
2.7.1
3.0.2

View File

@@ -1,15 +1,95 @@
= Changes
== 12.0.1 (2021-07-17)
* Updated to Ruby 3.0.1 - Brooke Kuhlmann
* Updated to Ruby 3.0.2 - Brooke Kuhlmann
== 12.0.0 (2021-03-16)
* Fixed environment configuration to source Bash resource - Brooke Kuhlmann
* Added Homebrew installation to Homebrew sripts - Brooke Kuhlmann
* Added Node packages script - Brooke Kuhlmann
* Added Ruby gems script - Brooke Kuhlmann
* Added Rust crates script - Brooke Kuhlmann
* Added bare package installer - Brooke Kuhlmann
* Added dotfiles script - Brooke Kuhlmann
* Added mas check to App Store install script - Brooke Kuhlmann
* Added version release notes - Brooke Kuhlmann
* Updated dev tools installer to agree to Rosetta license - Brooke Kuhlmann
* Updated install root detection to support Elm - Brooke Kuhlmann
* Updated setup software as configure software script - Brooke Kuhlmann
* Removed CPU detection in favor of architecture detection - Brooke Kuhlmann
* Refactored install scripts to separate script paths - Brooke Kuhlmann
== 11.2.0 (2021-02-27)
* Added Apple Silicon instructions - Brooke Kuhlmann
* Added CPU utility function - Brooke Kuhlmann
* Added Homebrew install function - Brooke Kuhlmann
* Added Homebrew utility path functions - Brooke Kuhlmann
* Added Rosetta to development tools install script - Brooke Kuhlmann
* Added environment configuration for scripts - Brooke Kuhlmann
* Updated to Circle CI 2.1.0 - Brooke Kuhlmann
* Updated to Docker Alpine Ruby image - Brooke Kuhlmann
* Refactored installer functions to be alphabetically sorted - Brooke Kuhlmann
* Refactored utility functions to be alphabetically sorted - Brooke Kuhlmann
* Refactored verifier functions to be alphabetically sorted - Brooke Kuhlmann
== 11.1.1 (2021-01-10)
* Fixed brew formulae list error - Brooke Kuhlmann
* Updated boot disk recovery documentation - Brooke Kuhlmann
== 11.1.0 (2021-01-03)
* Added caffeination to restore process - Brooke Kuhlmann
* Updated boot disk instructions for main disk format - Brooke Kuhlmann
* Updated troubleshooting documentation - Brooke Kuhlmann
* Removed README Startup Security Utility documentation - Brooke Kuhlmann
== 11.0.0 (2020-12-30)
* Fixed Circle CI configuration for Bundler config path - Brooke Kuhlmann
* Added Circle CI explicit Bundle install configuration - Brooke Kuhlmann
* Updated to Git Lint 2.0.0 - Brooke Kuhlmann
* Updated to Ruby 3.0.0 - Brooke Kuhlmann
== 10.0.0 (2020-11-15)
* Added macOS Big Sur support
* Updated project documentation to conform to Rubysmith template
* Updated to Git Lint 1.3.0
* Updated to Ruby 2.7.2
== 9.0.0 (2020-09-12)
* Fixed Homebrew cask verifier deprecation warning
* Removed Homebrew Mecurial formula verification check
* Removed unnecessary verifier code comments
* Refactored utility basename and extension utilities
== 8.2.0 (2020-07-22)
* Fixed project requirements
* Fixed screencast image URL
* Updated GitHub templates
* Updated README credit URL
* Updated README screencast URL
* Updated README screencast cover to SVG format
* Updated to Git Lint 1.0.0
* Refactored Rakefile requirements
== 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
* 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)

View File

@@ -51,7 +51,8 @@ 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].
leaders responsible for enforcement at link:mailto:brooke@alchemists.io?subject=Conduct[Brooke Kuhlmann].
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
@@ -102,7 +103,7 @@ disparagement of classes of individuals.
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].
Version 2.0].
Community Impact Guidelines were inspired by link:https://github.com/mozilla/diversity[Mozilla's
code of conduct enforcement ladder].

View File

@@ -3,4 +3,4 @@
source "https://rubygems.org"
gem "rake", "~> 13.0"
gem "git-cop", "~> 4.0"
gem "git-lint", "~> 2.0"

View File

@@ -150,7 +150,7 @@ additional liability.
END OF TERMS AND CONDITIONS
Copyright link:https://www.alchemists.io[Alchemists].
Copyright 2016 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
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]

View File

@@ -16,10 +16,10 @@ Config_ project is an opinionated configuration which meets the needs of my deve
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.
* *macOS* (this project) - The foundational framework for building custom 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.
this _macOS_ project which defines a custom machine implementation. The project is meant to be
forked for as many custom machine setups as needed.
toc::[]
@@ -28,48 +28,38 @@ toc::[]
* 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.
* Installs link:https://developer.apple.com/xcode[Xcode Command Line Tools].
* Installs link:http://brew.sh[Homebrew] formulas and casks.
* Installs link:http://www.apple.com/macosx/whats-new/app-store.html[App Store] software.
* Installs non-App Store software applications.
* Installs software application extensions.
* Installs dotfiles.
* Installs link:https://nodejs.org[Node] link:https://www.npmjs.com[packages].
* Installs link:https://www.ruby-lang.org[Ruby] link:https://rubygems.org[gems].
* Installs link:https://www.rust-lang.org[Rust] link:https://crates.io[crates].
* Applies basic default software settings.
* Configures installed software.
* 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]
[link=https://www.alchemists.io/screencasts/mac_os]
image::https://www.alchemists.io/images/screencasts/mac_os/cover.svg[Screencast,600,240,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)
. link:https://www.apple.com/macos/big-sur[macOS Big Sur]
. link:https://developer.apple.com/xcode[Xcode]
== 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
git checkout 12.0.1
----
== Usage
@@ -95,9 +85,13 @@ Install:
m: Install Mac App Store software.
a: Install application software.
x: Install application software extensions.
df: Install dotfiles.
np: Install Node packages.
rg: Install Ruby gems.
rc: Install Rust crates.
d: Apply default settings.
s: Setup installed software.
i: Install everything (i.e. executes all install options).
cs: Configure installed software.
i: Install everything (i.e. executes all install options in order listed).
Restore:
R: Restore settings from backup.
Manage:
@@ -138,64 +132,47 @@ macOS Boot Disk Tips
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.
3. Hold the POWER (Silicon) or OPTION (Intel) 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.
5. Use Disk Utility to delete and/or erase the hard drive including associated partitions.
6. Use Disk Utility to create a single "APFS" drive as a "GUID Partition Table".
7. 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.
macOS Boot Disk Recovery:
1. Start/restart the machine.
2. Hold the POWER (Silicon) or COMMAND+R (Intel) keys before the Apple logo appears.
3. Wait for the macOS installer to load from the recovery partition.
4. 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._
* `bin/apply_basic_settings` (optional, customizable): Applies basic and initial settings for
setting up a machine.
* `bin/apply_default_settings` (optional, customizable): Applies bare minimum system and application
defaults.
* `bin/configure_software` (optional, customizable): Configures installed software as part of the
post install process.
* `bin/create_boot_disk` (optional): Creates a macOS boot disk.
* `bin/install_app_store` (optional, customizable): Installs macOS, GUI-based, App Store
applications.
* `bin/install_applications` (optional, customizable): Installs macOS, GUI-based, non-App Store
applications.
* `bin/install_dev_tools` (required): Installs macOS development tools required by Homebrew.
* `bin/install_dotfiles` (optional, customizable): Installs personal dotfiles so the system is
tailored to your workflow.
* `bin/install_extensions` (optional, customizable): Installs macOS application extensions and
add-ons.
* `bin/install_homebrew_casks` (optional, customizable): Installs Homebrew Formulas.
* `bin/install_homebrew_formulas` (optional, customizable): Installs Homebrew Casks.
* `bin/install_node_packages` (optional, customizable): Installs Node packages.
* `bin/install_ruby_gems` (optional, customizable): Installs Ruby gems.
* `bin/install_rust_crates` (optional, customizable): Installs Rust crates.
* `bin/restore_backup` (optional, customizable): Restores system/application settings from backup
image.
* `bin/run` (required): The main script and interface for macOS setup.
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
@@ -206,20 +183,30 @@ link:https://www.alchemists.io/projects/mac_os-config[macOS Config] project for
== Troubleshooting
* When using link:https://pi-hole.net[Pi-hole], you might need to temporarily disable prior to
upgrading as you might experience various errors with Apple not being able to detect an internet
connection which prevents the installer from working.
* When using the boot disk and the installer fails in some catestrophic manner, reboot the machine
into recovery mode -- `POWER` (Silicon) or `COMMAND + R` (Intel) buttons -- to download and
install the last operating system used. Alternatively, you can also use `COMMAND + OPTION + R`
(Intel) to attemp to download the latest operating system.
* 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.
the `OPTION + COMMAND + R + P` (Intel) 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).
== Development
To contribute, run:
[source,bash]
----
git clone https://github.com/bkuhlmann/mac_os.git
cd mac_os
----
== Versioning
@@ -248,4 +235,4 @@ Read link:CHANGES.adoc[CHANGES] for details.
== Credits
Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann.html[Brooke Kuhlmann].
Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

View File

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

View File

@@ -6,6 +6,7 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/apply_basic_settings"
if [[ -x "$SCRIPT_PATH" ]]; then

View File

@@ -6,6 +6,7 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/apply_default_settings"
if [[ -x "$SCRIPT_PATH" ]]; then

16
bin/configure_software Executable file
View File

@@ -0,0 +1,16 @@
#! /usr/bin/env bash
# Configures installed software.
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/configure_software"
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else
printf "WARNING: Configure software script does not exist or is not executable.\n"
fi

View File

@@ -9,16 +9,16 @@ 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 " 3. Hold the POWER (Silicon) or OPTION (Intel) key before the Apple logo appears.\n"
printf " 4. Select the USB boot disk from the menu.\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"
printf " 2. Select the \"Restart...\" menu option.\n"
printf " 3. Hold down the COMMAND+R keys before the Apple logo appears.\n"
printf " 4. Wait for the macOS installer to load from the recovery partition.\n"
printf " 5. Use the dialog options to launch Disk Utility, reinstall the system, etc.\n"
printf " 5. Use Disk Utility to delete and/or erase the hard drive including associated partitions.\n"
printf " 6. Use Disk Utility to create a single \"APFS\" drive as a \"GUID Partition Table\".\n"
printf " 7. Install the new operating system.\n"
printf "\nmacOS Boot Disk Recovery:\n"
printf " 1. Start/restart the machine.\n"
printf " 2. Hold the POWER (Silicon) or COMMAND+R (Intel) keys before the Apple logo appears.\n"
printf " 3. Wait for the macOS installer to load from the recovery partition.\n"
printf " 4. Use the dialog options to launch Disk Utility, reinstall the system, etc.\n"
printf "\nCreating macOS boot disk...\n"

View File

@@ -6,9 +6,11 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_app_store"
if [[ -x "$SCRIPT_PATH" ]]; then
check_mas_install
"$SCRIPT_PATH"
else
printf "WARNING: App Store install script does not exist or is not executable.\n"

View File

@@ -6,6 +6,7 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_applications"
if [[ -x "$SCRIPT_PATH" ]]; then

View File

@@ -1,6 +1,6 @@
#! /usr/bin/env bash
# Installs development tooling requirements.
Installs development tooling requirements.
printf "Installing Xcode CLI tools...\n"
xcode-select --install
@@ -11,3 +11,7 @@ if [[ "$xcode_response" != "y" ]]; then
printf "ERROR: Xcode CLI tools must be installed before proceeding.\n"
exit 1
fi
if [[ "$(/usr/bin/arch)" == "arm64" ]]; then
softwareupdate --install-rosetta --agree-to-license
fi

16
bin/install_dotfiles Executable file
View File

@@ -0,0 +1,16 @@
#! /usr/bin/env bash
# Installs dotfiles.
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_dotfiles"
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else
printf "WARNING: Dotfiles install script does not exist or is not executable.\n"
fi

View File

@@ -6,6 +6,7 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_extensions"
if [[ -x "$SCRIPT_PATH" ]]; then

View File

@@ -6,9 +6,11 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_homebrew_casks"
if [[ -x "$SCRIPT_PATH" ]]; then
install_homebrew
"$SCRIPT_PATH"
else
printf "WARNING: Homebrew Casks install script does not exist or is not executable.\n"

View File

@@ -6,9 +6,11 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_homebrew_formulas"
if [[ -x "$SCRIPT_PATH" ]]; then
install_homebrew
"$SCRIPT_PATH"
else
printf "WARNING: Homebrew Formulas install script does not exist or is not executable.\n"

17
bin/install_node_packages Executable file
View File

@@ -0,0 +1,17 @@
#! /usr/bin/env bash
# Installs Node packages.
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_node_packages"
if [[ -x "$SCRIPT_PATH" ]]; then
check_yarn_install
"$SCRIPT_PATH"
else
printf "WARNING: Node packages install script does not exist or is not executable.\n"
fi

17
bin/install_ruby_gems Executable file
View File

@@ -0,0 +1,17 @@
#! /usr/bin/env bash
# Installs Ruby gems.
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_ruby_gems"
if [[ -x "$SCRIPT_PATH" ]]; then
install_ruby
"$SCRIPT_PATH"
else
printf "WARNING: Ruby gems install script does not exist or is not executable.\n"
fi

17
bin/install_rust_crates Executable file
View File

@@ -0,0 +1,17 @@
#! /usr/bin/env bash
# Installs Rust crates.
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_rust_crates"
if [[ -x "$SCRIPT_PATH" ]]; then
install_rust
"$SCRIPT_PATH"
else
printf "WARNING: Rust crates install script does not exist or is not executable.\n"
fi

View File

@@ -6,6 +6,7 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/restore_backup"
if [[ -x "$SCRIPT_PATH" ]]; then

10
bin/run
View File

@@ -23,6 +23,8 @@ else
exit 1
fi
configure_environment
while true; do
if [[ $# == 0 ]]; then
printf "\nUsage: run OPTION\n"
@@ -37,9 +39,13 @@ while true; do
printf " m: Install Mac App Store software.\n"
printf " a: Install application software.\n"
printf " x: Install application software extensions.\n"
printf " df: Install dotfiles.\n"
printf " np: Install Node packages.\n"
printf " rg: Install Ruby gems.\n"
printf " rc: Install Rust crates.\n"
printf " d: Apply default settings.\n"
printf " s: Setup installed software.\n"
printf " i: Install everything (i.e. executes all install options).\n"
printf " cs: Configure installed software.\n"
printf " i: Install everything (i.e. executes all install options in order listed).\n"
printf " Restore:\n"
printf " R: Restore settings from backup.\n"
printf " Manage:\n"

View File

@@ -1,15 +0,0 @@
#! /usr/bin/env bash
# Sets up and launches (if necessary) installed software.
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/setup_software"
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else
printf "WARNING: Software setup script does not exist or is not executable.\n"
fi

View File

@@ -1,61 +0,0 @@
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

@@ -2,6 +2,43 @@
# Defines software installer functions.
# 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_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 an application via a DMG file.
# Parameters: $1 (required) - URL, $2 (required) - Mount path, $3 (required) - Application name.
install_dmg_app() {
@@ -41,6 +78,163 @@ install_dmg_pkg() {
}
export -f install_dmg_pkg
# Installs a single file.
# Parameters: $1 (required) - URL, $2 (required) - Install path.
install_file() {
local file_url="$1"
local file_name=$(get_basename "$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
# Installs application code from a Git repository.
# 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_basename "$2")
local install_path="$2"
local options="--quiet"
if [[ -n "$3" ]]; then
local options="$options $3"
fi
if [[ ! -e "$install_path" ]]; then
printf "Installing: $install_path/$app_name...\n"
git clone $options "$repository_url" "$install_path"
printf "Installed: $app_name.\n"
verify_path "$install_path"
fi
}
export -f install_git_app
# Installs settings from a Git repository.
# 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"
local project_dir="$3"
local script="$4"
git clone "$repo_url"
(
cd "$project_dir"
git -c advice.detachedHead=false checkout "$repo_version"
eval "$script"
)
rm -rf "$project_dir"
}
export -f install_git_project
# Installs Homebrew.
# Parameters: None.
install_homebrew() {
if ! command -v brew > /dev/null; then
/bin/bash -c "$(curl --location --fail --silent --show-error https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
fi
}
export -f install_homebrew
# Installs a package via a zip file.
# Parameters: $1 (required) - URL, $2 (required) - Application name.
install_bare_pkg() {
local url="$1"
local app_name="$2"
local install_path=$(get_install_path "$app_name")
local work_file="$app_name.pkg"
if [[ ! -e "$install_path" ]]; then
download_file "$url" "$work_file"
install_pkg "$MAC_OS_WORK_PATH" "$app_name"
printf "Installed: $app_name.\n"
verify_application "$app_name"
fi
}
export -f install_bare_pkg
# 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
# 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 Ruby.
# Parameters: None.
install_ruby() {
local version="$(cat $HOME/.ruby-version | tr -d '\n')"
if [[ ! -x "$(command -v ruby)" && -n $(ruby --version | grep --quiet "$version") ]]; then
$(get_homebrew_bin_root)/ruby-install "ruby-$version"
chruby "$version"
gem update --system && gem update
fi
}
export -f install_ruby
# Installs Rust.
# Parameters: None.
install_rust() {
if ! command -v cargo > /dev/null; then
curl --proto "=https" --tlsv1.2 --fail --silent --show-error https://sh.rustup.rs | sh
fi
}
export -f install_rust
# 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 an application via a zip file.
# Parameters: $1 (required) - URL, $2 (required) - Application name.
install_zip_app() {
@@ -90,152 +284,6 @@ 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 (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")
local install_path="$2"
local options="--quiet"
if [[ -n "$3" ]]; then
local options="$options $3"
fi
if [[ ! -e "$install_path" ]]; then
printf "Installing: $install_path/$app_name...\n"
git clone $options "$repository_url" "$install_path"
printf "Installed: $app_name.\n"
verify_path "$install_path"
fi
}
export -f install_git_app
# Installs settings from a Git repository.
# 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"
local project_dir="$3"
local script="$4"
git clone "$repo_url"
(
cd "$project_dir"
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() {

View File

@@ -22,10 +22,18 @@ process_option() {
bin/install_applications;;
'x')
bin/install_extensions;;
'df')
bin/install_dotfiles;;
'np')
bin/install_node_packages;;
'rg')
bin/install_ruby_gems;;
'rc')
bin/install_rust_crates;;
'd')
bin/apply_default_settings;;
's')
bin/setup_software;;
'cs')
bin/configure_software;;
'i')
caffeinate_machine
bin/apply_basic_settings
@@ -35,17 +43,25 @@ process_option() {
bin/install_app_store
bin/install_applications
bin/install_extensions
bin/install_dotfiles
bin/install_node_packages
bin/install_ruby_gems
bin/install_rust_crates
bin/apply_default_settings
bin/setup_software
bin/configure_software
clean_work_path;;
'R')
caffeinate_machine
bin/restore_backup;;
'c')
verify_homebrew_formulas
verify_homebrew_casks
verify_app_store_applications
verify_applications
verify_extensions;;
verify_extensions
verify_node_packages
verify_ruby_gems
verify_rust_crates;;
'C')
caffeinate_machine;;
'ua')

View File

@@ -5,7 +5,7 @@ set -o errexit
set -o pipefail
IFS=$'\n\t'
export MAC_OS_BOOT_DISK_CREATOR="/Applications/Install macOS Catalina.app/Contents/Resources/createinstallmedia"
export MAC_OS_BOOT_DISK_CREATOR="/Applications/Install macOS Big Sur.app/Contents/Resources/createinstallmedia"
export MAC_OS_BOOT_DISK_PATH="/Volumes/Untitled"
export MAC_OS_WORK_PATH=/tmp/downloads
export MAC_OS_CONFIG_PATH="../mac_os-config"

View File

@@ -2,6 +2,68 @@
# Defines general utility functions.
# Caffeinate machine.
caffeinate_machine() {
local pid=$(pgrep -x caffeinate)
if [[ -n "$pid" ]]; then
printf "Machine is already caffeinated!\n"
else
caffeinate -s -u -d -i -t 3153600000 > /dev/null &
printf "Machine caffeinated.\n"
fi
}
export -f caffeinate_machine
# Cleans work path for temporary processing of installs.
clean_work_path() {
rm -rf "$MAC_OS_WORK_PATH"
}
export -f clean_work_path
# Answers the file or directory basename.
# Parameters: $1 (required) - The file path.
get_basename() {
printf "${1##*/}" # Answers file or directory name.
}
export -f get_basename
# Answers the file extension.
# Parameters: $1 (required) - The file name.
get_extension() {
local name=$(get_basename "$1")
local extension="${1##*.}" # Excludes dot.
if [[ "$name" == "$extension" ]]; then
printf ''
else
printf "$extension"
fi
}
export -f get_extension
# Answers Homebrew root path.
# Parameters: None.
get_homebrew_root() {
if [[ "$(/usr/bin/arch)" == "arm64" ]]; then
printf "%s" "/opt/homebrew"
else
printf "%s" "/usr/local/Homebrew"
fi
}
export -f get_homebrew_root
# Answers Homebrew binary root path.
# Parameters: None.
get_homebrew_bin_root() {
if [[ "$(/usr/bin/arch)" == "arm64" ]]; then
printf "%s" "/opt/homebrew/bin"
else
printf "%s" "/usr/local/bin"
fi
}
export -f get_homebrew_bin_root
# Answers the full install path (including file name) for file name.
# Parameters: $1 (required) - The file name.
get_install_path() {
@@ -11,35 +73,22 @@ get_install_path() {
}
export -f get_install_path
# 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=$(pgrep -x caffeinate)
if [[ -n "$pid" ]]; then
printf "Whoa, tweaker, machine is already caffeinated!\n"
else
caffeinate -s -u -d -i -t 3153600000 > /dev/null &
printf "Machine caffeinated.\n"
fi
}
export -f caffeinate_machine
# Answers the root install path for file name.
# Parameters: $1 (required) - The file name.
get_install_root() {
local file_name="$1"
local file_extension=$(get_file_extension "$file_name")
local file_extension=$(get_extension "$file_name")
# Special cases not supported by Homebrew.
if [[ "$file_name" == "elm" ]]; then
printf "/usr/local/bin"
return
fi
# Dynamically build the install path based on file extension.
case $file_extension in
'')
printf "/usr/local/bin";;
printf "$(get_homebrew_bin_root)";;
'app')
printf "/Applications";;
'prefPane')
@@ -52,23 +101,37 @@ get_install_root() {
}
export -f get_install_root
# Answers the file extension.
# Parameters: $1 (required) - The file name.
get_file_extension() {
local name=$(get_file_name "$1")
local extension="${1##*.}" # Excludes dot.
if [[ "$name" == "$extension" ]]; then
printf ''
else
printf "$extension"
# Checks Yarn has been installed and exits if otherwise.
# Parameters: None.
check_yarn_install() {
if ! command -v yarn > /dev/null; then
printf "%s\n" "ERROR: Yarn can't be found. Please ensure Homebrew and Yarn have been installed."
exit 1
fi
}
export -f get_file_extension
export -f check_yarn_install
# Answers the file name.
# Parameters: $1 (required) - The file path.
get_file_name() {
printf "${1##*/}" # Answers file or directory name.
# Checks Mac App Store (mas) CLI has been installed and exits if otherwise.
# Parameters: None.
check_mas_install() {
if ! command -v mas > /dev/null; then
printf "%s\n" "ERROR: Mac App Store (mas) CLI can't be found."
printf "%s\n" " Please ensure Homebrew and mas (i.e. brew install mas) have been installed."
exit 1
fi
}
export -f get_file_name
export -f check_mas_install
# Configures shell for new machines and ensures PATH is properly configured for running scripts.
# Parameters: None.
configure_environment() {
if [[ ! -s "$HOME/.bash_profile" ]]; then
printf "%s\n" "if [ -f ~/.bashrc ]; then . ~/.bashrc; fi" > "$HOME/.bash_profile"
fi
if [[ ! -s "$HOME/.bashrc" ]]; then
printf "%s\n" 'export PATH="/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"' > "$HOME/.bashrc"
source "$HOME/.bashrc"
fi
}
export -f configure_environment

View File

@@ -2,64 +2,6 @@
# Defines verification/validation functions.
# Checks for missing Homebrew formulas.
verify_homebrew_formulas() {
printf "Checking Homebrew formulas...\n"
local applications="$(brew list)"
while read line; do
# Skip blank or comment lines.
if [[ "$line" == "brew install"* ]]; then
local application=$(printf "$line" | awk '{print $3}')
# Exception: "gpg" is the binary but is listed as "gnugp".
if [[ "$application" == "gpg" ]]; then
application="gnupg"
fi
# Exception: "hg" is the binary but is listed as "mercurial".
if [[ "$application" == "hg" ]]; then
application="mercurial"
fi
verify_listed_application "$application" "${applications[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew_formulas"
printf "Homebrew formula check complete.\n"
}
export -f verify_homebrew_formulas
# Checks for missing Homebrew casks.
verify_homebrew_casks() {
printf "\nChecking Homebrew casks...\n"
local applications="$(brew cask list)"
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"
@@ -67,7 +9,6 @@ verify_app_store_applications() {
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[*]}"
@@ -78,17 +19,17 @@ verify_app_store_applications() {
}
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"
# Verifies application exists.
# Parameters: $1 (required) - The file name.
verify_application() {
local file_name="$1"
local install_path=$(get_install_path "$file_name")
if [[ "${applications[*]}" != *"$application"* ]]; then
printf " - Missing: $application\n"
if [[ ! -e "$install_path" ]]; then
printf " - Missing: $file_name\n"
fi
}
export -f verify_listed_application
export -f verify_application
# Checks for missing applications suffixed by "APP_NAME" as defined in settings.sh.
verify_applications() {
@@ -99,7 +40,6 @@ verify_applications() {
# For each application name, check to see if the application is installed. Otherwise, skip.
for name in $file_names; do
# Pass the key value to verfication.
verify_application "${!name}"
done
@@ -107,20 +47,6 @@ verify_applications() {
}
export -f verify_applications
# Verifies application exists.
# Parameters: $1 (required) - The file name.
verify_application() {
local file_name="$1"
# 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_application
# Checks for missing extensions suffixed by "EXTENSION_PATH" as defined in settings.sh.
verify_extensions() {
printf "\nChecking application extensions...\n"
@@ -138,14 +64,116 @@ verify_extensions() {
}
export -f verify_extensions
# Checks for missing Homebrew casks.
verify_homebrew_casks() {
printf "\nChecking Homebrew casks...\n"
local applications="$(brew list --casks)"
while read line; do
if [[ "$line" == "brew cask install"* ]]; then
local application=$(printf "$line" | awk '{print $4}')
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 Homebrew formulas.
verify_homebrew_formulas() {
printf "Checking Homebrew formulas...\n"
local applications="$(brew list --formulae)"
while read line; do
if [[ "$line" == "brew install"* ]]; then
local application=$(printf "$line" | awk '{print $3}')
# Exception: "gpg" is the binary but is listed as "gnugp".
if [[ "$application" == "gpg" ]]; then
application="gnupg"
fi
verify_listed_application "$application" "${applications[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew_formulas"
printf "Homebrew formula check complete.\n"
}
export -f verify_homebrew_formulas
# 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_listed_application
# 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
# Checks for missing Node packages.
verify_node_packages() {
local packages=$(yarn global list --json | grep '"type":"info"')
printf "\nChecking Node packages...\n"
while read line; do
if [[ "$line" == "yarn global add"* ]]; then
local package=$(printf "$line" | awk '{print $4}')
verify_listed_application "$package" "${packages[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_node_packages"
printf "Node packages check complete.\n"
}
export -f verify_node_packages
# Checks for missing Ruby gems.
verify_ruby_gems() {
local gems="$(gem list --no-versions)"
printf "\nChecking Ruby gems...\n"
while read line; do
if [[ "$line" == "gem install"* ]]; then
local gem=$(printf "$line" | awk '{print $3}')
verify_listed_application "$gem" "${gems[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_ruby_gems"
printf "Ruby gems check complete.\n"
}
export -f verify_ruby_gems
# Checks for missing Rust crates.
verify_rust_crates() {
printf "\nChecking Rust crates...\n"
local crates="$(ls -A1 $HOME/.cargo/bin)"
while read line; do
if [[ "$line" == "cargo install"* ]]; then
local crate=$(printf "$line" | awk '{print $3}')
verify_listed_application "$crate" "${crates[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_rust_crates"
printf "Rust crates check complete.\n"
}
export -f verify_rust_crates