Skip to main content

Scriptworker Readme

https://firefox-ci-tc.services.mozilla.com/api/github/v1/repository/mozilla-releng/scriptworker/main/badge.svg https://coveralls.io/repos/github/mozilla-releng/scriptworker/badge.svg?branch=master Documentation Status

Scriptworker implements the TaskCluster worker model, then launches a pre-defined script.

This worker was designed for Releng processes that need specific, limited, and pre-defined capabilities.

Free software: MPL2 License

Usage

Credentials can live in ./scriptworker.yaml, ./secrets.json, ~/.scriptworker.

  • Launch: scriptworker [config_path]

Testing

Without integration tests install tox, then

NO_CREDENTIALS_TESTS=1 uv run tox -e py311

Without any tests connecting to the net, then NO_TESTS_OVER_WIRE=1 uv run tox -e py311

With integration tests, first create a client in the Taskcluster UI with the scopes:

queue:cancel-task:test-dummy-scheduler/*
queue:claim-work:test-dummy-provisioner/dummy-worker-*
queue:create-task:lowest:test-dummy-provisioner/dummy-worker-*
queue:define-task:test-dummy-provisioner/dummy-worker-*
queue:get-artifact:SampleArtifacts/_/X.txt
queue:scheduler-id:test-dummy-scheduler
queue:schedule-task:test-dummy-scheduler/*
queue:task-group-id:test-dummy-scheduler/*
queue:worker-id:test-dummy-workers/dummy-worker-*

Then generate a no priviledge personal access token in Github for the scriptworker_github_token (to avoid rate limiting) and create a ./secrets.json or ~/.scriptworker that looks like:

{
    "integration_credentials": {
        "clientId": "...",
        "accessToken": "...",
    }
    "scriptworker_github_token": "..."
}

then to run all tests: uv run tox

Metadata

Release files for scriptworker 64.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scriptworker 64.0.1
File Size Uploaded Provenance Actions
scriptworker-64.0.1.tar.gz 107.4 kB With provenance Details for scriptworker-64.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for scriptworker 64.0.1
File Interpreter ABI Platform Actions
scriptworker-64.0.1-py3-none-any.whl Python 3 none any Details for scriptworker-64.0.1-py3-none-any.whl

Total release size: 193.2 kB

Release files / scriptworker-64.0.1.tar.gz

Download URL scriptworker-64.0.1.tar.gz
Size 107.4 kB
Tags Source
SHA-256 checksum
How to use checksums
c1ac7f04aee229d7dd2297249ed6169c6db61923909eec28a6f6c629664ddd70
BLAKE2b-256 checksum
How to use checksums
fc8bc570606e05204b637c6077556c2f315db490dc3b0af7185b3222639bbb82
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.

Transparency log

Release files / scriptworker-64.0.1-py3-none-any.whl

Download URL scriptworker-64.0.1-py3-none-any.whl
Size 85.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d41f3a1ee9dda4397a5c981a62d861c7f90d511efd844bc86b6aa35c656c1ec6
BLAKE2b-256 checksum
How to use checksums
5a6b3f231597e2f2dbc182c64f69e6814c0cd7567ffbe281331db09ed4ebac12
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.

Transparency log

Security for scriptworker 64.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for scriptworker-64.0.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

64.0.1 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page