Skip to content

Commit

Permalink
Update release instructions
Browse files Browse the repository at this point in the history
During the recent first automated release, we noticed that there's an
extra step to be done in this repository. It's because the version of
"theia-traceviewer" needs to be updated in the example applications.

I think this does not happen automatically, even though the example
applications are part of the lerna workspace, because of our current
.gitignore file, which ignores these folders.

Signed-off-by: Marc Dumais <marc.dumais@ericsson.com>
  • Loading branch information
marcdumais-work committed Mar 21, 2024
1 parent 54ee04b commit 5115472
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -411,11 +411,12 @@ yarn version:minor
yarn version:patch
```
Modify the _version tag_ in file `./RELEASE`, to match the new release. Then amend the release commit to include this change:
Modify the _version tag_ in file `./RELEASE`, to match the new release, and similarly update the requested version for the `theia-traceviewer` dependency in both the browser and electron example applications (`examples/electron/package.json` and `examples/browser/package.json`)
Then amend the release commit to include these changes:
```bash
<edit ./RELEASES to update tag>
git add RELEASE && git commit --amend
git add RELEASE examples/electron/package.json examples/browser/package.json && git commit --amend
```
Finally, push the branch and use it to create a PR. When the PR is merged, a GitHub release should be created with auto-generated release notes, as well as a git tag. Then the `publish-latest` CI job should trigger and if everything goes well, publish the new version of the repo's packages to `npm`.
Expand Down

0 comments on commit 5115472

Please sign in to comment.