# Packages
Package atomics provides types that can be concurrently accessed and modified, without caller code needing to implement locking.
Package caching provides an easy to make a cache on top of the gc package used to track idle resources in taskcluster-worker.
No description provided by the author
Package fetcher provides means for plugins and engines to fetch resources with generic references.
Package gc contains the GarbageCollector which allows cacheable resources to register themselves for disposal when we run low on resources.
Package ioext contains interfaces and implementations for when the default io types are not sufficient.
Package mocks contains mock implementations of various interfaces useful for writing unit-tests.
Package monitoring provides multiple implementations of runtime.Monitor.
Package util contains a few simple utilites that has no internal dependencies.
Package webhookserver provides implementations of the WebHookServer interface.
# Functions
IsMalformedPayloadError casts error to MalformedPayloadError.
MergeMalformedPayload merges a list of MalformedPayloadError objects.
NewMalformedPayloadError creates a MalformedPayloadError object, please make sure to include a detailed description of the error, preferably using multiple lines and with examples.
NewShutdownManager will return a shutdown manager appropriate for the host that the worker is being run on.
NewTaskContext creates a TaskContext and associated TaskContextController.
NewTemporaryStorage return a TemporaryFolder rooted in the given path.
NewTemporaryTestFolderOrPanic creates a TemporaryFolder as in a subfolder of os.TempDir, or panics.
RenderDocument creates a markdown document with given title from a list of sections.
# Constants
TODO: (jonasfj) Don't distinguish between cancel/abort.
Enumerate task status to aid life-cycle decision making Use strings for benefit of simple logging/reporting.
Enumerate task status to aid life-cycle decision making Use strings for benefit of simple logging/reporting.
Enumerate task status to aid life-cycle decision making Use strings for benefit of simple logging/reporting.
Enumerate task status to aid life-cycle decision making Use strings for benefit of simple logging/reporting.
Reasons why a task can reach an exception state.
Reasons why a task can reach an exception state.
Reasons why a task can reach an exception state.
Reasons why a task can reach an exception state.
Reasons why a task can reach an exception state.
Reasons why a task can reach an exception state.
Reasons why a task can reach an exception state.
Reasons why a task can reach an exception state.
Enumerate task status to aid life-cycle decision making Use strings for benefit of simple logging/reporting.
Enumerate task status to aid life-cycle decision making Use strings for benefit of simple logging/reporting.
# Variables
ErrFatalInternalError is used to signal that a fatal internal error has been logged and that the worker should gracefully terminate/reset.
ErrLogNotClosed represents an invalid attempt to extract a log while it is still open.
ErrNonFatalInternalError is used to indicate that the operation failed because of internal error that isn't expected to affect other tasks.
# Structs
Environment is a collection of objects that makes up a runtime environment.
ErrorArtifact wraps all of the needed fields to upload an error artifact.
LifeCycleTracker implements Stoppable as two atomics.Once that you can wait for, or get a blocking channel from.
The MalformedPayloadError error type is used to indicate that some operation failed because of malformed-payload.
RedirectArtifact wraps all of the needed fields to upload a redirect artifact.
S3Artifact wraps all of the needed fields to upload an s3 artifact.
A Section represents a section of markdown documentation.
StoppableOnce is a wrapper that ensures we only call StopGracefully and StopNow once and never call StopGracefully after StopNow.
The TaskContext exposes generic properties and functionality related to a task that is currently being executed.
TaskContextController exposes logic for controlling the TaskContext.
The TaskInfo struct exposes generic properties from a task definition.
# Interfaces
A Monitor is responsible for collecting logs, stats and error messages.
ShutdownManager implements a method for listening for shutdown events.
Stoppable is an worker with a life-cycle that can be can be stopped.
TemporaryFile is a temporary file that will be removed when closed.
TemporaryFolder is a temporary folder that is backed by the filesystem.
TemporaryStorage can create temporary folders and files.
# Type aliases
An ExceptionReason specifies the reason a task reached an exception state.
TaskStatus represents the current status of the task.