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

Jump to bottom

Adding release notes to README #354

Merged
merged 2 commits into from
Jan 27, 2023
Merged

Adding release notes to README #354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b527d39
adding release notes to README
loiswells97 Jan 27, 2023
e866040
updating changelog
loiswells97 Jan 27, 2023
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## [Unreleased]

### Added

- Added release notes to `README.md` (#354)

## [0.12.0] - 2023-01-27

### Changed
Expand Down
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ For example, to load the page with the Sense Hat always showing, add [`?sense_ha

## Deployment

Deployment is managed through Giithub actions. The UI is deployed to staging and production environments via an S3 bucket. This requires the following environment variables to be set
Deployment is managed through Github actions. The UI is deployed to staging and production environments via an S3 bucket. This requires the following environment variables to be set

* `AWS_ACCESS_KEY_ID`
* `AWS_REGION`
Expand All @@ -80,3 +80,19 @@ Other variables that pertain to the app, rather than its deployment are set with

Currently the build is deployed to both S3 and Heroku. The PR should get updated with the Heroku URL, and the web component demo is at `/web-component.html` on the Heroku review app domain.

### Release Process

A new release of `editor-ui` is created via following process:

1. Create a branch on Github for the release.
2. Update `CHANGELOG.md` with new version number and date in the list of changes under `Unreleased`.
3. At the bottom of `CHANGELOG.md`, add a link for the new version and update the `Unreleased` link to point to the latest version`…HEAD`.
4. Update the version number in `package.json` to the new version number.
5. Push these changes to the release branch on Github.
6. Create a PR on Github for the release branch and put the `CHANGELOG` diff for the new release in the description.
7. Get someone to approve the PR and then merge.
8. Within the releases tab, create a new tag with the version number of the new release with the target set to `main`.
9. Give the release the same name as the tag and paste the `CHANGELOG` diff in the description.
10. Set the release to be the latest release and publish.
11. Go to Cloudflare and under `Workers > KV` select `editor` and change the `production-ref` to `releases/<new_version_number>`.
12. Go to `editor.raspberrypi.org` to see the new changes on production... 🚀