Skip to content

Commit e8a8602

Browse files
committed
docs: add notes
1 parent 7b05ff5 commit e8a8602

3 files changed

Lines changed: 34 additions & 6 deletions

File tree

docs/pages/developers/package.mdx

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@ import { LinkButton } from "@/components/Button";
22
import { Github } from "lucide-react";
33
import { Callout, Steps } from "nextra/components";
44

5-
# Clockwork.yml
5+
# Clockwork.yaml
66

7-
Clockwork.yml is a file that contains metadata about a package.
7+
`clockwork.yaml` is a file that contains metadata about your project.
88

99
## Example
1010

11-
```yaml copy filename="clockwork.yml"
11+
```yaml copy filename="clockwork.yaml"
1212
name: my-package
1313
description: My awesome clockwork package
1414
version: 1.0.0 # github release tag
1515
# Watch Face Format version that's required for installing your package
1616
watchFaceFormatVersion: 2 # or unspecified for any version
1717
```
1818
19-
<Callout type="warning">
20-
The clockwork package file must be named `clockwork.yml` (`clockwork.yaml`
21-
will be ignored).
19+
<Callout type="info">
20+
Starting with 1.1.6, Clockwork accepts both `clockwork.yml` and
21+
`clockwork.yaml` as package files.
2222
</Callout>
2323

2424
## Fields
@@ -31,6 +31,11 @@ watchFaceFormatVersion: 2 # or unspecified for any version
3131
| `watchFaceFormatVersion` | The version of Watch Face Format required to use the package. If unspecified, any version is allowed. |
3232
| [`scripts`](#scripts) | Scripts to run when the package is installed or updated. |
3333

34+
<Callout type="info">
35+
Currently `watchFaceFormatVersion` only warns the user and doesn't prevent
36+
installation of the package. This will change in the future.
37+
</Callout>
38+
3439
## Scripts
3540

3641
| Field | Description |

docs/pages/developers/registry.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ If you meet all these requirements, feel free to create a pull request.
3939

4040
_Even if you meet all the requirements, your pull request may be rejected, but you are still **encouraged to create a pull request** if you haven't already._
4141

42+
##### Recommendations for maintaining a package
43+
44+
- If you introduce breaking changes, you should document it and publish it as a major (e.g. 1.0.0 -> 2.0.0) release so Clockwork doesn't automatically update it.
45+
4246
### Adding your package to the registry
4347

4448
<Steps>

docs/pages/guides/packages.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,25 @@ Clockwork works best in combination with [XML Preprocessor](https://github.com/g
5050

5151
In this example, we import the component from `packages`, where Clockwork stores all your downloaded packages, currently this is the only way to import components from packages, but that will change in the future. Visit XML Preprocessor's [documentation on `<Import/>`](https://github.com/gondwanasoft/xml-preprocessor?tab=readme-ov-file#import) to learn more.
5252

53+
## Updating packages
54+
55+
You can update all your packages to minor and patch versions by running:
56+
57+
```shell
58+
clockwork update
59+
```
60+
61+
If you want to update your packages to major, minor, and patch versions, run:
62+
63+
```shell
64+
clockwork upgrade
65+
```
66+
67+
<Callout type="warning">
68+
Major versions of packages may have breaking changes. Check the package's
69+
documentation or changelog if you encounter issues.
70+
</Callout>
71+
5372
## Packages in the registry
5473

5574
<Manifest />

0 commit comments

Comments
 (0)