Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document automatic previews in README #806

Merged
merged 2 commits into from
Jan 28, 2025
Merged

document automatic previews in README #806

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96016d0
document automatic previews in README
jamesscottbrown Jan 23, 2025
a75f845
add links to storybook of dev and prod branches
jamesscottbrown Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,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
Loading