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

docs: nx release and publish #825

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: nx release and publish #825

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42d0f31
docs: nx release and publish
rti Feb 3, 2025
6b7b8c6
Merge branch 'main' into add-some-docs-about-nx-to-readme
rti Mar 5, 2025
7f74fd1
Merge branch 'main' into add-some-docs-about-nx-to-readme
rti Mar 11, 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
34 changes: 31 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,37 @@ For more information on testing, see the [README](./test/README.md).

## Release process

WBS Deploy and WBS images are released using this repository. The process
involves updating upstream component versions to be used, building images,
testing all the images together and finally publishing them.
WBS Deploy and WBS Images are released using this repository. The process involves updating upstream component versions, building images, testing all the images together, releasing them by generating a changelog, git tagging the new version and finally publishing it.

### Preparing a release

```bash
# Do a release dry-run (nothing but informative output will happen)
# for all projects with unreleased changes
./nx release --dry-run

# Do a release (bump version, generate changelog and git tag it) for a single
# project (e.g. wikibase).
# Nothing will be pushed or published with this command, but a new commit with
# changelog and package.json adjustments will be created locally. This should
# happen on `main`. Also, a new git tag with the new version of the released
# project will be created locally.
./nx release -p wikibase
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I generally am a fan of orchestrating releases locally in this way, but how does this square with our current GHA setup for these things? Let's catch-up about it on today's meeting.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A release can be created just like this locally, or, in GHA using our 📦 Create a WBS Release workflow.

Both paths will generate a release commit (ideally on main) and a tag. With the former you have to push from local to origin/main (works because we are all admins), the latter will push to main using our Wikibase Suite Bot.

As soon as the tag arrives, GHA will trigger 📦 Build and Publish a WBS Image Release to Dockerhub to publish to dockerhub in case of an image release.


# Push the changelog and package.json changes to Github.
# Yes, we push to `main` here ¯\_(ツ)_/¯
# ATTENTION!!! THIS DOES NOT PUSH THE NEW GIT TAG
# ATTENTION!!! PUSHING ALSO THE NEW GIT TAG WOULD PUBLISH IMAGE RELEASES TO DOCKERHUB
git push
```

### Publishing a release

Deploy releases are currently just published in this git repo via a git tag. Pushing the tag to Github effectively publishes a deploy version.

Image releases are published on Dockerhub. The actual push to Dockerhub is handled by Github Actions and is triggered by pushing a git tag to Github.

For example `./nx release -p wikibase` would tag the next wikibase version with a git tag such as `wikibase@1.2.3`. Pushing this tag with `git push origin wikibase@1.2.3` will trigger Github Actions to publish the `wikibase` project from this tag to Dockerhub.

### Release checklist Phabricator template

Expand Down