Last updated at 2021-07-26 09:52:11 by ouit0354
Differences between revisions 6 and 9 (spanning 3 versions)
Revision 6 as of 2016-03-10 16:45:43
Size: 2136
Editor: ouit0354
Comment:
Revision 9 as of 2017-04-11 15:01:34
Size: 2397
Editor: ouit0354
Comment:
Deletions are marked like this. Additions are marked like this.
Line 29: Line 29:
    * A valid {{{category}}} (see this list of categories FIXME)     * A valid {{{category}}} (see this [[AutoPkg/Contributing/Categories|list of categories]])
Line 35: Line 35:
 * The parent recipe should, of course, be set to the Identifier of the recipe you are overriding, the {{{autopkg make-override}}} command should take care of this too.   * The {{{ParentRecipe}}} should, of course, be set to the Identifier of the recipe you are overriding, the {{{autopkg make-override}}} command should take care of this too.
  * Please '''remove''' the {{{ParentTrustInfo}}} key and its corresponding dict if you created your override with a version of autopkg > 1.0 - currently this leaves information about your local file system in the override.

Orchard Autopkg Override Guidelines

  • You should only create overrides for .munki recipes
  • The override should contain:
    • An Attribution dict containing the copyright and author information dict. e.g.:
        <key>Attribution</key>
           <dict>
             <key>Copyright</key>
             <string>University of Oxford 2016</string>
             <key>Author</key>
             <dict>
               <key>Name</key>
               <string>Ben Goodstein</string>
               <key>Email</key>
               <string>ben.goodstein at it.ox.ac.uk</string>
               <key>Github</key>
               <string>fuzzylogiq</string>
             </dict>
           </dict>
    • The generic identifier starting with local.munki. that autopkg make-override inserts is fine.

    • In the Input dict:

      • Remove any keys/values that you are NOT intending to override, such as URLs and regexes that make-override has copied over from the parent recipes.

      • NAME should be set to the name of the software in title case with spaces expressed as underscores

      • MUNKI_REPO_SUBDIR (which should hopefully be exposed by the parent recipe) should be set to %NAME% (unless the software forms part of a suite of connected apps e.g. Microsoft_Office_2016

      • There should be a pkginfo dict with the following:

        • A catalogs array containing 'testing' (can be set to 'unstable' whilst doing internal testing but must be changed once in the auto-build)

        • A valid category (see this list of categories)

        • A short description which should be free of marketing speak but should concisely describe the app and its function(s)

        • A developer (try to ensure that this matches other software by the same developer in the repo)

        • A display_name either set to %NAME% or the Name with spaces if more than one word.

        • A name set to %NAME%

        • unattended_install set to True

    • The ParentRecipe should, of course, be set to the Identifier of the recipe you are overriding, the autopkg make-override command should take care of this too.

    • Please remove the ParentTrustInfo key and its corresponding dict if you created your override with a version of autopkg > 1.0 - currently this leaves information about your local file system in the override.


Orchard is a close co-operation of