Clockwork.yaml

clockwork.yaml is a file that contains metadata about your project.

Example

clockwork.yaml

name: my-package
description: My awesome clockwork package
version: 1.0.0 # github release tag
# Watch Face Format version that's required for installing your package
watchFaceFormatVersion: 2 # unspecified or * for any version

Starting with 1.1.6, Clockwork accepts both clockwork.yml and clockwork.yaml as package files.

Fields

Field	Description
`name`	The name of the package.
`description`	A short description of the package.
`version`	The version of the package. Must be a valid GitHub release tag.
`watchFaceFormatVersion`	The version of Watch Face Format required to use the package. If unspecified or `*`, any version is allowed.
`scripts`	Scripts to run when the package is installed or updated.

Currently watchFaceFormatVersion only warns the user and doesn’t prevent installation of the package. This will change in the future.

Scripts

Field	Description
`postinstall`	Run when the package is first installed.
`postupdate`	Run when the package is updated, may be run even if contents aren’t updated.

Example

clockwork.yaml

# ...
scripts:
  postinstall: echo "Package installed!"
  postupdate: echo "Package updated!"

Registry Publishing a package