Skip to content

Add release.sh and RELEASING.md #121

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

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

Add release.sh and RELEASING.md #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2242306
Add step for releasin on crates.io
franciszekjob Feb 24, 2026
d040d83
Add `release.sh` and `RELEASING.md`
franciszekjob Feb 25, 2026
34bcc7d
Merge branch 'master' of https://github.com/software-mansion/universa…
franciszekjob Feb 25, 2026
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ In rare cases where a prerelease with a new unstable sierra version exists, and
run the following command with the requested prerelease version:

```shell
curl -L https://raw.githubusercontent.com/software-mansion/universal-sierra-compiler/master/scripts/install.sh | sh -s -- v2.0.0-rc.0
curl -L https://raw.githubusercontent.com/software-mansion/universal-sierra-compiler/master/scripts/install.sh | sh -s -- v2.8.0-rc.0
```

> 📝 **Note**
Expand Down
7 changes: 7 additions & 0 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Instruction For Creating New `universal-sierra-compiler` Releases

1. Create a new branch.
2. Run `./scripts/release.sh MAJOR.MINOR.PATCH`.
3. Create a pull request with title `Release MAJOR.MINOR.PATCH`.
4. Merge introduced changes to master branch.
5. Manually dispatch release workflow on Github from `master` branch.
10 changes: 10 additions & 0 deletions scripts/release.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#!/bin/bash
set -euxo pipefail

VERSION=$1

sed -i.bak "/\[package\]/,/version =/ s/version = \".*/version = \"${VERSION}\"/" Cargo.toml
rm Cargo.toml.bak 2> /dev/null

sed -i ".bak" "s@install.sh | sh -s -- v.*@install.sh | sh -s -- v${VERSION}@" README.md
rm README.md.bak 2> /dev/null
Copy link
Contributor

@ddoktorski ddoktorski Mar 5, 2026

Choose a reason for hiding this comment

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

In case of a stable release it'll update the README's installation command with the stable version, which leads to a confusion: we have "..run the following command with the requested prerelease version" but then show a stable version as the example. I suggest we remove that line entirely and keep 2.8.0-rc.0 as a static example that doesn't change with new releases.