Skip to content
Merged
Show file tree
Hide file tree
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
7 changes: 0 additions & 7 deletions .github/codeql/codeql-config.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/CreateRelease.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ name: Create a Release
on:
workflow_dispatch:
push:
branches: [dev]
branches: [main]

permissions:
id-token: write
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/PRLabelChecker.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Label Checker
on:
pull_request:
branches: dev
branches: main
types: [opened, labeled, unlabeled, synchronize, reopened]
permissions:
pull-requests: read
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ValidatePullRequests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ name: Validate Pull Request

on:
pull_request:
branches: [ dev, 'release/**' ]
branches: [ main, 'release/**' ]

permissions:
id-token: write
Expand Down
102 changes: 0 additions & 102 deletions .github/workflows/codeql.yml

This file was deleted.

8 changes: 4 additions & 4 deletions docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,23 @@ cargo set-version 0.18.0

For simplicity, we keep the version number consistent across all crates in the repository.

Create a PR with these changes and merge it into the `dev` branch.
Create a PR with these changes and merge it into the `main` branch.

## Create a tag

When the `dev` branch has reached a state in which you want to release a new Cargo version, you should create a tag. Although you can do this from the GitHub releases page, we currently recommend doing the tag from the command line. Do so with the following commands:
When the `main` branch has reached a state in which you want to release a new Cargo version, you should create a tag. Although you can do this from the GitHub releases page, we currently recommend doing the tag from the command line. Do so with the following commands:

```bash
git tag -a v0.18.0 -m "A brief description of the release"
git push origin v0.18.0 # if you've named your git remote for the hyperlight-dev/hyperlight-js repo differently, change 'origin' to your remote name
```

>Note: we'll use `v0.18.0` as the version for the above and all subsequent instructions. You should replace this with the version you're releasing. Make sure your version follows [SemVer](https://semver.org) conventions as closely as possible, and is prefixed with a `v` character. *In particular do not use a patch version unless you are patching an issue in a release branch, releases from dev should always be minor or major versions*.
>Note: we'll use `v0.18.0` as the version for the above and all subsequent instructions. You should replace this with the version you're releasing. Make sure your version follows [SemVer](https://semver.org) conventions as closely as possible, and is prefixed with a `v` character. *In particular do not use a patch version unless you are patching an issue in a release branch, releases from main should always be minor or major versions*.
If you are creating a patch release see the instructions [here](#patching-a-release).

## Create a release branch (no manual steps)

After you push your new tag in the previous section, the ["Create a Release Branch"](https://github.com/hyperlight-dev/hyperlight-js/blob/dev/.github/workflows/CreateReleaseBranch.yml) CI job will automatically run. When this job completes, a new `release/v0.18.0` branch will be automatically created for you.
After you push your new tag in the previous section, the ["Create a Release Branch"](https://github.com/hyperlight-dev/hyperlight-js/blob/main/.github/workflows/CreateReleaseBranch.yml) CI job will automatically run. When this job completes, a new `release/v0.18.0` branch will be automatically created for you.

## Create a new GitHub release and publish the crates

Expand Down
Loading