Compare commits

...

5 Commits
1.3.1 ... 2.0.0

Author SHA1 Message Date
Brooke Kuhlmann
e1bc7e939a Added version release changes. 2017-04-09 15:51:59 -06:00
Brooke Kuhlmann
8bf0ef473d Added Homebrew Casks install script.
- Provides support for installing Homebrew Casks.
2017-02-17 19:27:37 -07:00
Brooke Kuhlmann
79f7103179 Refactored Homebrew software as Homebrew Formulas.
- Allows for expansion of additional Homebrew software in the future
  (i.e. taps, bottles, casks, etc.)
2017-02-17 19:18:02 -07:00
Brooke Kuhlmann
38fa30a028 Updated README semantic versioning order.
- It's easier to think about versions in the order of major, minor,
  and maintenance.

[ci skip]
2017-02-07 07:20:00 -07:00
Brooke Kuhlmann
a2a2820098 Updated contributing documentation.
- Simplified the documentation to be more succinct in what is required
  (especially in terms of the Style Guides and GitHub pull request and
  issue template).

[ci skip]
2017-02-05 11:26:54 -07:00
8 changed files with 104 additions and 81 deletions

View File

@@ -1,3 +1,10 @@
# 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) # v1.3.1 (2017-01-08)
- Fixed install of zip app downloads with sub-directories. - Fixed install of zip app downloads with sub-directories.

View File

@@ -1,33 +1,25 @@
# Overview # Overview
Thanks for taking an interest in this open source project. Your support and involvement is greatly appreciated. The Thanks for taking an interest in this open source project. Your support and involvement is greatly
following details what you need to know in order to contribute. appreciated. The following details what you need to know in order to contribute.
# Requirements # Requirements
- Follow these [Basic Programming Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/basic.md). Read through the [Programming Style
- Follow these [Code Review Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/code_reviews.md). Guides](https://github.com/bkuhlmann/style_guides/tree/master/programming).
- Follow these [Git Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/git.md).
- Follow these [Bash Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/languages/bash.md).
- Follow these [CSS Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/languages/css.md).
- Follow these [Ruby Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/languages/ruby/ruby.md).
# Contributing Code # Contributing Code
0. Read the project README thoroughly before starting. 0. Read the project README before starting.
0. Fork the master branch of the repository. 0. Fork the `master` branch of the repository.
0. Ensure there are no setup, usage, and/or test issues (again, follow the README). 0. Ensure there are no setup, usage, and/or test issues (see README for details).
0. Add tests for new functionality (refactoring and documentation changes can be excluded). 0. Add tests for new functionality and ensure they pass.
0. Ensure all tests pass. 0. Submit a pull request and follow the instructions it provides.
0. Push your feature branch and submit a pull request.
# Submitting Issues # Submitting Issues
0. Submit an issue via the GitHub Issues tab (assuming one does not already exist). 0. Submit an issue via the GitHub Issues tab (assuming one does not already exist).
0. Clearly describe the issue (including steps to reproduce). 0. Follow the instructions provided within the GitHub issue template.
0. Specify your enviroment setup (OS, browser, language, etc. with version info).
0. Provide a stack dump (if possible).
0. Explain any additional details that might help diagnose the problem quickly.
# Feedback # Feedback

View File

@@ -45,7 +45,8 @@ the two projects are meant to be used:
- Downloads and installs development tools (required by Homebrew): - Downloads and installs development tools (required by Homebrew):
- [Xcode Command Line Tools](https://developer.apple.com/xcode) - [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) - [Java SE Development Kit](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
- Downloads, installs, and configures [Homebrew](http://brew.sh) command line software. - Downloads, installs, and configures [Homebrew Formulas](http://brew.sh).
- Downloads, installs, and configures [Homebrew Casks](https://caskroom.github.io).
- Downloads, installs, and configures - Downloads, installs, and configures
[App Store](http://www.apple.com/macosx/whats-new/app-store.html) software. [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 non-App Store software applications.
@@ -72,7 +73,7 @@ Current Version (stable):
git clone https://github.com/bkuhlmann/mac_os.git git clone https://github.com/bkuhlmann/mac_os.git
cd mac_os cd mac_os
git checkout v1.3.1 git checkout v2.0.0
Master Version (unstable): Master Version (unstable):
@@ -92,7 +93,8 @@ You will be presented with the following options:
Install: Install:
b: Apply basic settings. b: Apply basic settings.
t: Install development tools. t: Install development tools.
h: Install Homebrew software. hf: Install Homebrew Formulas.
hc: Install Homebrew Casks.
m: Install Mac App Store software. m: Install Mac App Store software.
a: Install application software. a: Install application software.
x: Install application software extensions. x: Install application software extensions.
@@ -140,7 +142,8 @@ All executable scripts can be found in the `bin` folder:
- `bin/install_dev_tools`: Installs macOS development tools required by Homebrew. - `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 - `bin/install_extensions`: Installs macOS application extensions and add-ons. *This is meant to be
customized.* customized.*
- `bin/install_homebrew`: Installs Homebrew managed software. *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 - `bin/restore_backup`: Restores system/application settings from backup image. *This is meant to be
customized.* customized.*
- `bin/run`: The main script and interface for macOS setup. - `bin/run`: The main script and interface for macOS setup.
@@ -158,9 +161,9 @@ project is built upon the functions found in the `lib` folder. See the
Read [Semantic Versioning](http://semver.org) for details. Briefly, it means: Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
- Major (X.y.z) - Incremented for any backwards incompatible public API changes. - 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 # Code of Conduct

View File

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

18
bin/install_homebrew_casks Executable file
View File

@@ -0,0 +1,18 @@
#! /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
printf "WARNING: Homebrew Casks install script does not exist or is not executable.\n"
fi

18
bin/install_homebrew_formulas Executable file
View File

@@ -0,0 +1,18 @@
#! /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
printf "WARNING: Homebrew Formulas install script does not exist or is not executable.\n"
fi

View File

@@ -39,7 +39,8 @@ while true; do
printf " Install:\n" printf " Install:\n"
printf " b: Apply basic settings.\n" printf " b: Apply basic settings.\n"
printf " t: Install development tools.\n" printf " t: Install development tools.\n"
printf " h: Install Homebrew software.\n" printf " hf: Install Homebrew Formulas.\n"
printf " hc: Install Homebrew Casks.\n"
printf " m: Install Mac App Store software.\n" printf " m: Install Mac App Store software.\n"
printf " a: Install application software.\n" printf " a: Install application software.\n"
printf " x: Install application software extensions.\n" printf " x: Install application software extensions.\n"

View File

@@ -14,8 +14,10 @@ process_option() {
bin/apply_basic_settings;; bin/apply_basic_settings;;
't') 't')
bin/install_dev_tools;; bin/install_dev_tools;;
'h') 'hf')
bin/install_homebrew;; bin/install_homebrew_formulas;;
'hc')
bin/install_homebrew_casks;;
'm') 'm')
bin/install_app_store;; bin/install_app_store;;
'a') 'a')