Skip to content

Commit

Permalink
docs(README): add note about publishing process
Browse files Browse the repository at this point in the history
Signed-off-by: jrhender <john.henderson@energyweb.org>
  • Loading branch information
jrhender committed Feb 7, 2025
1 parent c29ee0c commit 4c063eb
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,13 @@ To run tests across all apps and libraries in one command, a rush script has bee
$ rush test
```

## Release Process

Releases are done by manually creating a new release in GitHub.
Tooling like `release-please` or `release-it` could be used in the future to automate this process.

The release will trigger [a GitHub Action](/.github/workflows/container-image-publish.yml) to publish the new version to the GitHub Container Registry.

## Docs Editing

To edit the documentation, you can run the following command to start the docs server:
Expand Down

0 comments on commit 4c063eb

Please sign in to comment.