Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Shea Craig committed Apr 3, 2015
1 parent 44bb233 commit ac24156
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### 0.3.8 (April 2, 2015) The Soft Bullet In
### 0.3.8 (April 3, 2015) The Soft Bullet In

CHANGES:

Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,10 +328,11 @@ Then, to include in a recipe, use the ```self_service_icon``` key, with a string

If you don't want to worry about icons, just leave out the ```self_service_icon``` key and JSSImporter will skip it.

Template
=================
Template Substitution Variables
===============================
All templates used in JSS recipes will perform text substitution before attempting to upload to the JSS. A text substitution variable is indicated by surrounding a variable name in "%"'s. Substitution will occur if an AutoPkg environement variable exists for that substition (i.e., if you put ```%giant_burrito%``` in your template, and there's no AutoPkg "giant_burrito", then nothing will happen).

Substitution variables available in templates include:
JSSImporter defines the following default substitution variables:
- ```%VERSION%```: The AutoPkg version variable.
- ```%PKG_NAME%```: The name of the package. Specifically, the display name that the JSS uses to represent that package. Usually the filename.
- ```%PROD_NAME%```: The value of the input variable ```%prod_name%```. Note, ```%prod_name%``` is a required recipe input variable.
Expand All @@ -341,6 +342,8 @@ Substitution variables available in templates include:
- ```%SITE_NAME%```: If you want to specify a SITE for you policy or group.
- ```%SITE_ID%```: If you want to specify a SITE for you policy or group.

However, any AutoPkg environment variable may be accessed in this manner. For example, ```AUTOPKG_VERSION``` can be substituted in a template by wrapping in "%", i.e. ```%AUTOPKG_VERSION%```.

Using Overrides
=================
All of my recipes are designed to allow you to use overrides to change the major input variables. However, if you *do* use overrides, you may experience unexpected difficulties. Since the override recipe lives in your ```~/Library/AutoPkg/RecipeOverrides/``` folder, the %RECIPE_DIR% substitution in those recipes now points to the RecipeOverrides folder rather than the base jss.recipe. You will probably need to copy all of the recipe's needed support files: templates, scripts, and icons, to the override directory. Hopefully some time soon AutoPkg can add a %PARENT_RECIPE_DIR% variable for overrides to use.
Expand Down

0 comments on commit ac24156

Please sign in to comment.