Bug 1943269 - Update partner attribution doc to mention macOS and Windows stub installer r=bhearsum,releng-reviewers DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D235289
This commit is contained in:
Johan Lorenzo
@@ -3,10 +3,14 @@ Partner attribution
|
||||
.. _partner attribution:
|
||||
|
||||
In contrast to :ref:`partner repacks`, attributed builds only differ from the normal Firefox
|
||||
builds by the adding a string in the dummy windows signing certificate. We support doing this for
|
||||
full installers but not stub. The parameters of the string are carried into the telemetry system,
|
||||
tagging an install into a cohort of users. This a lighter weight process because we don't
|
||||
repackage or re-sign the builds.
|
||||
builds by the adding a string in the dummy windows signing certificate. We support doing this for:
|
||||
|
||||
* Windows stub installers,
|
||||
* Windows full installers,
|
||||
* macOS DMGs.
|
||||
|
||||
The parameters of the string are carried into the telemetry system, tagging an install into
|
||||
a cohort of users. This a lighter weight process because we don't repackage or re-sign the builds.
|
||||
|
||||
Parameters & Scheduling
|
||||
-----------------------
|
||||
@@ -19,9 +23,9 @@ Partner attribution uses a number of parameters to control how they work:
|
||||
* ``release_partners``
|
||||
|
||||
The enable parameter is a boolean, a simple on/off switch. We set it in shipit's
|
||||
`is_partner_enabled() <https://github.com/mozilla-releng/shipit/blob/main/api/src/shipit_api/admin/release.py#L93>`_ when starting a
|
||||
release. It's true for Firefox betas >= b8 and releases, but otherwise false, the same as
|
||||
partner repacks.
|
||||
`is_partner_enabled() <https://github.com/mozilla-releng/shipit/blob/046826e96999bde08fdc33cce03c4576b89d8904/api/src/shipit_api/admin/release.py#L77>`_
|
||||
when starting a release. It's true for Firefox betas >= b5 and releases, but otherwise false, the
|
||||
same as partner repacks.
|
||||
|
||||
``release_partner_config`` is a dictionary of configuration data which drives the task generation
|
||||
logic. It's usually looked up during the release promotion action task, using the Github
|
||||
@@ -50,18 +54,21 @@ An example config looks like this:
|
||||
.. code-block:: yaml
|
||||
|
||||
defaults:
|
||||
medium: distribution
|
||||
source: mozilla
|
||||
medium: distribution
|
||||
source: mozilla
|
||||
configs:
|
||||
- campaign: sample
|
||||
content: sample-001
|
||||
locales:
|
||||
- en-US
|
||||
- de
|
||||
- ru
|
||||
platforms:
|
||||
- win64-shippable
|
||||
- win32-shippable
|
||||
- campaign: sample
|
||||
content: sample-001
|
||||
locales:
|
||||
- en-US
|
||||
- de
|
||||
- ru
|
||||
platforms:
|
||||
- macosx64-shippable
|
||||
- win64-shippable
|
||||
- win32-shippable
|
||||
upload_to_candidates: true
|
||||
publish_to_releases: true
|
||||
|
||||
The four main parameters are ``medium, source, campaign, content``, of which the first two are
|
||||
common to all attributions. The combination of ``campaign`` and ``content`` should be unique
|
||||
@@ -73,46 +80,61 @@ Non-empty lists of locales and platforms are required parameters (NB the `-shipp
|
||||
the platforms).
|
||||
|
||||
The Firefox installers are uploaded into the `candidates directory
|
||||
<https://archive.mozilla.org/pub/firefox/candidates/>`_.
|
||||
<https://archive.mozilla.org/pub/firefox/candidates/>`_ when ``upload_to_candidates`` is set to true and
|
||||
into the `release directory <https://archive.mozilla.org/pub/firefox/releases/partners/>`_ when
|
||||
``publish_to_releases`` is too.
|
||||
|
||||
|
||||
Repacking process
|
||||
-----------------
|
||||
|
||||
Attribution only has two kinds:
|
||||
Attribution only works with these type of tasks:
|
||||
|
||||
* attribution - add attribution code to the regular builds
|
||||
* beetmover - move the files to a partner-specific destination
|
||||
* bouncer - create partner-attributed links that point to the latest version.
|
||||
|
||||
Attribution
|
||||
^^^^^^^^^^^
|
||||
|
||||
* kinds: ``release-partner-attribution``
|
||||
* platforms: Any Windows, runs on linux
|
||||
* upstreams: ``repackage-signing`` ``repackage-signing-l10n``
|
||||
* kind: ``release-partner-attribution``
|
||||
|
||||
There is one task, calling out to `python/mozrelease/mozrelease/attribute_builds.py
|
||||
<https://hg.mozilla.org/releases/mozilla-release/file/default/python/mozrelease/mozrelease/attribute_builds.py>`_.
|
||||
There is one task per OS.
|
||||
|
||||
It takes as input the repackage-signing and repackage-signing-l10n artifacts, which are all
|
||||
target.exe full installers. The ``ATTRIBUTION_CONFIG`` environment variable controls the script.
|
||||
It produces more target.exe installers.
|
||||
On Windows, `python/mozrelease/mozrelease/attribute_builds.py
|
||||
<https://hg.mozilla.org/releases/mozilla-release/file/default/python/mozrelease/mozrelease/attribute_builds.py>`_
|
||||
handles the attribution. It takes full and stub installers as input. The ``ATTRIBUTION_CONFIG``
|
||||
environment variable controls the script. It produces more installers. The size of
|
||||
``ATTRIBUTION_CONFIG`` variable may grow large if the number of configurations increases,
|
||||
and it may be necessary to pass the content of ``attribution_config.yml`` to the script
|
||||
instead, or via an artifact of the promotion task.
|
||||
|
||||
The size of ``ATTRIBUTION_CONFIG`` variable may grow large if the number of configurations
|
||||
increases, and it may be necessary to pass the content of ``attribution_config.yml`` to the
|
||||
script instead, or via an artifact of the promotion task.
|
||||
On macOS, the `dmg attribute <https://github.com/mozilla/libdmg-hfsplus/blob/d6287b5afc2406b398de42f74eba432f2123b937/dmg/dmg.c#L133>`_
|
||||
binary handles the attribution. Unlike Windows, ``ATTRIBUTION_CONFIG`` is not used. Instead,
|
||||
the payload is passed as a CLI argument.
|
||||
|
||||
Beetmover
|
||||
^^^^^^^^^
|
||||
|
||||
* kinds: ``release-partner-attribution-beetmover``
|
||||
* platforms: N/A, scriptworker
|
||||
* upstreams: ``release-partner-attribution``
|
||||
* kinds: ``release-partner-attribution-beetmover``, ``release-beetmover-push-to-release``
|
||||
|
||||
Moves and renames the artifacts to their public location in the `candidates directory
|
||||
The first kind moves and renames the artifacts to their public location in the `candidates directory
|
||||
<https://archive.mozilla.org/pub/firefox/candidates/>`_.
|
||||
|
||||
Each task will have the ``project:releng:beetmover:action:push-to-partner`` and
|
||||
``project:releng:beetmover:bucket:release`` scopes. There's a partner-specific
|
||||
code path in `beetmoverscript
|
||||
<https://github.com/mozilla-releng/scriptworker-scripts/tree/master/beetmoverscript>`_.
|
||||
|
||||
The second kind moves it under the release directory. In the case of partner builds, this is
|
||||
`pub/firefox/releases/partners/ <https://archive.mozilla.org/pub/firefox/releases/partners/>`_.
|
||||
|
||||
Bouncer
|
||||
^^^^^^^
|
||||
|
||||
* kinds: ``release-partner-repack-bouncer-sub`` and ``release-bouncer-aliases``.
|
||||
|
||||
``release-partner-repack-bouncer-sub`` creates the bouncer entries for both partner repacks
|
||||
and partner attributed builds. ``release-bouncer-aliases`` creates/updates the aliases of
|
||||
all type of builds (standard Firefox, partner repacks, partner attributed builds) to point
|
||||
to their latest bouncer entry.
|
||||
|
||||
Reference in New Issue
Block a user