Using make from the wiki

When a page prefixed 'Make' is changed on this website, the build server processes the data on the page and may initiate a build.

Using make from the command line

From the commandline make processes the information obtained from the given url

Data

format

The data is required to be in a very specific format (see: Make Seaside-Magma-Pier). The format is based upon yaml mappings (a dictionary of key - value pairs), with two exceptions designed to support presentation in this wiki.

1. stars, as used for 'bold/emphasis' are ignored in keys
2. square brackets, as used for linking, are ignored in values

layout

Within a page, an individual data record is introduced by '---' (displayed as a horizontal rule in pbwiki), and concluded by '...'. This enables data records to be interspersed with descriptive text.

...

In reading this data, only the last record on the page is significant, for each record data is inherited from the record above so that only changes need be recorded in subsequent records.

fields in detail

• name: string if not present a value is taken from the name of the page, without the prefix 'Make' (note: quotes are not needed for strings in yaml)
• moniker: string an abbreviation for this product, used for output directory/image names.
• build: integer the build number for this product, if absent or set to 'AUTO', an incrementing number will be used, if set to 0, no build number will be used in directory names.
• overwrite: true/false will overwrite a previous build with the same build: no and moniker:
• dont: true/false record the information in this record but do not actually perform the build.
• by: to indicate the initiator of the build or product
• vm version: If a specific version is required, otherwise, the default is used according to the server admin information
• REFER: This field can be used in a record, to begin reading another page or file for make information. This is intended to allow build info to be moved away from the main page if it becomes too cluttered. It may also be used to delegate the build info to another source, such as a locally editable file on your own web server for convenience.
• image: The path to the starting image for this build (see The file system ) This can be a url to a zip file containing the image.
• output to: override the default output directory giving an explicit path
• image name: The name the starting image is initially given (defaults to moniker), and will have on the final 'save&quit' unless squeak explicitly saves itself under another name/version.
• parameters: parameters for the invocation of squeak to perform the build/test/or report.
• comment: an ignored field for informational purposes (unknown fields are ignored, but kept in the info file for that build.)
• image must change: if true, then build will only take place if the source image modification date has changed.
• needs installer: if true, then the startup script IBS.st is used to bootstrap installer first, otherwise startup script AS.st is used which simply calls Installer to process the squeak commandline parameters.
• delay: Will reschedule the make to actually occur so many minutes later
• candidate: if true a symlink is made to indicate that this build is an new release candidate NEW_RC
• release: if true a symlink is made to indicate that this build is the current RELEASE.
• END: Stop here, finish processing records at this point.

Building

Initiating a build

When the page is edited a build is initiated. If the build designated by the build: field already exists then no build will occur, unless overwrite: true is present.

Updating information after a build

If the build, designated by the build: field has already been performed, then the build information record is updated and no actual build occurs. This allows the build information to be updated after the fact, enabling comments to be included with a specific build.

If you wish to update the information belonging to a build that is not the last record on the page, temporarily insert an END: marker to make that record the last.

The file system

• auto-build/
  • input/
    • images/ (read-only)
      • Squeak3.9-final-7067.image
      • Squeak3.9-final-7067.changes
  • output/
    • Make/
      • SMP/ (example)
        • 0001 First the worst/
        • 0002 Second the best/
  • wip/ (work in progress area)
  • system/ (read-only)
    • action.scripts/