@awell-health/awell-extensions 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,12 +6,24 @@ You can find all the documentation [here](https://developers.awellhealth.com/awe
|
|
|
6
6
|
|
|
7
7
|
Read about our contributing guidelines [here](https://developers.awellhealth.com/awell-extensions/docs/getting-started/contributing-guidelines). To contribute code, you'll need to first fork the repository. Once you have forked the repository, create your extension (or make your changes) and submit a pull request for our team to review.
|
|
8
8
|
|
|
9
|
+
**Reviews may take 24 hours or longer. To help smooth the process, please be sure your `settings`, `fields`, and `datapoints` are well defined and documented.**
|
|
10
|
+
|
|
9
11
|
Of course, we also welcome [discussions](https://github.com/awell-health/awell-extensions/discussions)... show us what you're working on!
|
|
10
12
|
|
|
11
13
|
## Building your own extension
|
|
12
14
|
|
|
13
15
|
We encourage you to fork the repo and build custom actions and webhooks to support your organization's needs. We have provided a sample `hello world` extension, which is located in `./extensions/hello-world`.
|
|
14
16
|
|
|
17
|
+
## Releasing Extensions
|
|
18
|
+
|
|
19
|
+
When updates are made to the public extensions repository, the release process involves:
|
|
20
|
+
- Packaging a new release by merging into the `main` branch (internal engineers can test locally by creating a `release/vX.X.X` branch)
|
|
21
|
+
- Updating the `@awell-health/awell-extensions` dependency version in our private `awell-extension-server` repository
|
|
22
|
+
- Publishing a release of our private repository
|
|
23
|
+
- Deploying that release to staging/sandbox/production environments
|
|
24
|
+
|
|
25
|
+
This process is currently manual, and we ask you to please be patient with our PR reviews and deployments while we work to automate this process.
|
|
26
|
+
|
|
15
27
|
### Actions and webhooks
|
|
16
28
|
|
|
17
29
|
Please read about [custom actions](https://developers.awellhealth.com/awell-extensions/docs/custom-actions/what-are-custom-actions) and [webhooks](https://developers.awellhealth.com/awell-extensions/docs/webhooks/what-are-webhooks) to learn about how you can use them to support no-code flows for your care ops builders.
|