Skip to content

Commit

Permalink
document automatic previews in README (#806)
Browse files Browse the repository at this point in the history
* document automatic previews in README

* add links to storybook of dev and prod branches
  • Loading branch information
jamesscottbrown authored Jan 28, 2025
1 parent 64a29f9 commit 79fce29
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,22 @@ When writing changelog messages, consider the suggestions from [keep a changelog

When a release is made, `changeset` will add these descriptions of changes to a `CHANGELONG.md` file in the directory of the appropriate package; the version numbers in `package.json` files will also be updated appropriately.


### Storybook previews

When a PR is created targeting the `dev` branch, then the `deploy-previews` workflow (defined in [this file](./.github/workflows/deploy-preview.yml)) should be triggered automatically.
This will deploy an instance of storybook to `https://dev.ldn-gis.co.uk/storybook-<branch_name>`.

The action should automatically re-run if you push additional commits to the source branch of the PR.

Note that this action will immediately abort if there is a conflict that would prevent the PR from being automatically merged into the `dev` branch.
The action will also not be automatically triggered for PRs targeting other branches, but it can still be manually triggered [through the GitHub web UI](https://github.com/Greater-London-Authority/ldn-viz-tools/actions/workflows/deploy-preview.yml).

An action also deploys:

* the `dev` branch to [https://dev.ldn-gis.co.uk/storybook-dev/](https://dev.ldn-gis.co.uk/storybook-dev/)
* the `main` branch (which should match the latest released version) to [https://greater-london-authority.github.io/ldn-viz-tools/](https://greater-london-authority.github.io/ldn-viz-tools/)

### Making releases/publishing packages

Rather than having a fixed release schedule, we make releases when someone wants to make use of unreleased code in the `main` branch.
Expand Down

0 comments on commit 79fce29

Please sign in to comment.