Skip to content
Open
Changes from all commits
Commits
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
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ essreduce
├── essimaging
├── essnmx
├── essreflectometry
── esssans
── esssans
└── essspectroscopy
```

Expand Down Expand Up @@ -107,15 +107,17 @@ Commit the updated `pixi.lock`.

### Releasing a package

Push a tag with the package prefix:
Currently, releases **must** be done via the Github web UI:

```bash
git tag essreduce/26.3.0
git push origin main --tags
```
* Navigate to the [Releases](https://github.com/scipp/ess/releases) and click "Draft a new release".
* Create a tag which contains the name of the package and the version, separated by a `/`: e.g. `essreduce/26.3.0`.
* Copy the tag name in the release title, and leave the release notes empty unless you have a specific note that needs to be there.
* The release notes will be populated during the release build, as it figures out which PRs are relevant to the given release.

The `release.yml` workflow builds, publishes to PyPI, and deploys docs.

*Creating a release via pushing a tag from the command line is currently broken (because of the release notes bot).*

Comment on lines +119 to +120

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Are we ever going to fix it?
I thought we decided it's too complicated to make the bot working for both scenarios.

### How CI works

- **On PRs:** Only changed packages are tested (changing `essreduce` also tests `essimaging`)
Expand Down