# Releasing

_This guide is a work-in-progress._

## Updating the version

- Update `lib/opal/version.rb`
- Update `opal/corelib/constants.rb` with the same version number along with release dates

## Updating the changelog

- Ensure all the unreleased changes are documented in UNRELEASED.md
- Run `bin/rake changelog VERSION=v1.2.3` specifying the version number you're about to release

## The commit

- Commit the updated changelog along with the version bump using this commit message:
  "Release v1.2.3"

## Opal docs

- Open `opal-docs` and run `bin/build v1.2.3`
- Then run `bin/deploy`

## Opal site

- Open `opal.github.io` and update the opal version in the `Gemfile`
- run `bin/build`
- `git push` the latest changes

## Opal CDN

- Run `bin/release v1.2.3`

# Releasing

_This guide is a work-in-progress._

## Updating the version

- Update `lib/opal/version.rb`
- Update `opal/corelib/constants.rb` with the same version number along with release dates

## Updating the changelog

- Ensure all the unreleased changes are documented in UNRELEASED.md
- Run `bin/rake changelog VERSION=v1.2.3` specifying the version number you're about to release

## The commit

- Commit the updated changelog along with the version bump using this commit message:
  "Release v1.2.3"
- Push the commit and run `bin/rake release` to release the new version to Rubygems
- Go to GitHub releases and create a new release from the latest tag pasting the contents of UNRELEASED.md
- Empty UNRELEASED.md and run `bin/rake changelog`
- Push the updated changelog

## Opal docs

- Open `opal-docs` and run `bin/build v1.2.3`
- Then run `bin/deploy`

## Opal site

- Open `opal.github.io` and update the opal version in the `Gemfile`
- run `bin/build`
- `git push` the latest changes

## Opal CDN

- Run `bin/release v1.2.3`

Add instructions on how to do github releases
Add instructions on how to do github releases
