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.

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

how to release documentation #233

Merged
merged 2 commits into from
Dec 9, 2023
Merged
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
70 changes: 70 additions & 0 deletions RELEASE_howto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# How to do a HDM release

## Prepare gemset

```shell
bundle config set --local path 'vendor/bundle'
bundle install
```

## Merge pull requests

1. check labels on issues and pull requests on github
1. check mentions from pull requests to issues
1. merge all desired pull requests

## Create Release PR

```shell
export CHANGELOG_GITHUB_TOKEN="github_TOKEN"
git switch -c release/X.Y.Z
```

edit `Rakefile`, search replace `future_release`

```text
config.future_release = 'X.Y.Z'
```

Create Changelog

```shell
bundle exec rake changelog
```

check generated changlog

Create release pull request

```shell
git add -A
git commit -m 'Release vX.Y.Z'
git push
```

Open pull request on GitHub, add `skip-changelog` label and merge

## Set release tag

```shell
git switch main
git pull -r
git tag vX.Y.Z
git push --tags
```

## Generate GitHub release

Open [Releases - betadots/hdm](https://github.com/betadots/hdm/releases) in browser.

Click on `Draft a new release`

Set release title to tag name (X.Y.Z)

Choose tag

Click on `generate release notes`

Publish release

Done.