User:Bhearsum/Release Automation Documentation: Difference between revisions

(Created page with "== Notes and Definitions == * 'Staging server' typically means stage.mozilla.org for production (read: real) releases and staging-stage.build.mozilla.org for staging (read: test)...")
 
 
(2 intermediate revisions by the same user not shown)
Line 40: Line 40:


The release configs themselves have a number of variables and options in them. These are discussed below.
The release configs themselves have a number of variables and options in them. These are discussed below.
==== sourceRepositories ====
This variable is information dense dictionary and mostly contains information only relevant to Tagging.
Each key of sourceRepositories (eg. "mozilla"), has a value of a dict with the following structure:
* name - The name of the source repository, without any leading directories
* clonePath - (staging only) Where to clone this repository from in repo_setup
* path - Where to clone this repository for everything else (tagging, builds, repacks, et. al)
* revision - The revision to base this release on. If relbranch is None or the provided one does not exist, the automation will update to this revision before creating the relbranch.
* relbranch - The name of the relbranch to use for this release. If set to None, it will be generated automatically. If provided and exists, the automation will update to it before doing any bumping or tagging. If provided and doesn't exist, it will be created.
* bumpFiles - This is another dict, whose keys are the paths in the sourceRepo, and whose values are *another* dict, with the following structure.
** version - The version number to use in this file on the relbranch
** nextVersion - The version number to use in this file on the default branch
Here's a concrete example of sourceRepositories for a Firefox build. Note that the bump file versions are typically factored out to earlier variables to avoid repetition.
<pre>
releaseConfig['sourceRepositories'] = {
  'mozilla': {
    'name': 'mozilla-central',
    'path': 'mozilla-central',
    'revision': 'aaaaabbbbcccc',
    'relbranch': None
    'bumpFiles': {
      'browser/config/version.txt': {
        'version': releaseConfig['appVersion'],
        'nextVersion': releaseConfig['nextAppVersion'],
      },
      'config/milestone.txt': {
        'version': releaseConfig['milestone'],
        'nextVersion': releaseConfig['nextMilestone'],
      },
    }
  }
}
</pre>
==== Others ====
{| class="fullwidth-table"
{| class="fullwidth-table"
| '''Variable'''
| '''Variable'''
Line 49: Line 84:
| hgSshKey
| hgSshKey
| The path to the ssh key to used when pushing things back to hg.mozilla.org. The username in hgUsername must be setup to accept this key in order for the automation to work correctly. Path is generally in the ~/ form in order to be platform independent.
| The path to the ssh key to used when pushing things back to hg.mozilla.org. The username in hgUsername must be setup to accept this key in order for the automation to work correctly. Path is generally in the ~/ form in order to be platform independent.
|-
| sourceRepoName
| The name of the source repository to build from. Generally is the last part of sourceRepoPath, which is described below. This must be one of the branches listed in config.py
|-
| sourceRepoPath
| The path, relative to the root of the hgHost, to the source repository to build from. http://hgHost/sourceRepoPath must be a cloneable Mercurial repository.
|-
| sourceRepoClonePath
| This variable is only used in staging. This is the path to the source repository which will be cloned as part of the repo_setup build. All other parts of the automation use sourceRepoPath.
|-
| sourceRepoRevision
| This is the revision which will be branched + version bumped from. It should be _exactly_ what is signed off on in release-drivers mail. It should also be updated when buildNumber is greater than 1 (ie respins).
|-
| relbranchOverride
| This is used in two cases. Most commonly, you must pass it when buildNumber > 1, and should be the release branch which was generated for build1; use <nowiki>''</nowiki> for build1. Less commonly, you can pass it to override the automatically generated relbranch name for a build1. Note, the default format is like this: GECKO191_YYYYMMDD_RELBRANCH, where YYYYMMDD is the current date in PST. Note that this is different than Bootstrap, when uses UTC.
|-
|-
| l10nRepoClonePath
| l10nRepoClonePath
Line 73: Line 93:
| l10nRevisionFile
| l10nRevisionFile
| This is the path, relative to the master's directory, which contains a listing of all of the locales to build, and their changesets. This file is read in at buildmaster start/reconfig time and the information is passed along to ReleaseTaggingFactory, which tags all of the repositories for this release. Any subsequent steps which require a list of locales will pull them from shipped-locales. This is a bug that may or may not be fixed.
| This is the path, relative to the master's directory, which contains a listing of all of the locales to build, and their changesets. This file is read in at buildmaster start/reconfig time and the information is passed along to ReleaseTaggingFactory, which tags all of the repositories for this release. Any subsequent steps which require a list of locales will pull them from shipped-locales. This is a bug that may or may not be fixed.
|-
| l10nRelbranch
| The relbranch to use for l10n repositories. See "relbranch" in the preceding section for mechanics. Generally should be set to the same thing as the sourceRepositories relbranches.
|-
|-
| shippedLocalesPath
| shippedLocalesPath
Line 103: Line 126:
| milestone
| milestone
| The milestone version of the current platform release. Eg, 1.9.1b2
| The milestone version of the current platform release. Eg, 1.9.1b2
|-
| nextAppVersion/nextMilestone
| These variables control what the appVersion and milestone will be bumped to on the "default" branch.
|-
|-
| buildNumber
| buildNumber
canmove, Confirmed users
6,442

edits