Skip to content

Document the revert-github-release script in the project README #59

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

Merged
merged 1 commit into from
Jan 9, 2024
Merged

Document the revert-github-release script in the project README #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 19 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Tested on Ruby 3.0+
* [Changing the pre-release type](#changing-the-pre-release-type)
* [Creating the release after pre-releases](#creating-the-release-after-pre-releases)
* [After Running create-github-release](#after-running-create-github-release)
* [Reverting `create-github-release`](#reverting-create-github-release)
* [FAQ](#faq)
* [What if I want to reverse the changes made by this script?](#what-if-i-want-to-reverse-the-changes-made-by-this-script)
* [How is the changelog updated?](#how-is-the-changelog-updated)
* [Development](#development)
* [Contributing](#contributing)
Expand Down Expand Up @@ -320,33 +320,28 @@ Finally, publish your gem to rubygems.org with the command:
rake release:rubygem_push
```

## FAQ
### Reverting `create-github-release`

### What if I want to reverse the changes made by this script?
Should you decide that `create-github-release` was run in error, the `revert-github-release`
script is provided by this gem to revert the changes made.

You will need to delete the Git tag and branch created by this script both remotely and locally.
This script must be run before the release PR is merged to the default branch.

In your worktree run the following commands:
This script must be run in the root directory of the work tree with the release
branch checked out. This is the state that the `create-github-release` script leaves
you in.

```shell
DEFAULT_BRANCH=main
RELEASE_VERSION=1.0.1
RELEASE_TAG="v${RELEASE_VERSION}"
RELEASE_BRANCH="release_${RELEASE_TAG}"
REMOTE=origin

# Make sure the release branch is not checked out
git checkout "${DEFAULT_BRANCH}"

# Delete remote branch and tag
# Deleting the remote branch will automatically close the release PR
git push "${REMOTE}" --delete "${RELEASE_BRANCH}"
git push "${REMOTE}" --delete "${RELEASE_TAG}"

# Delete the local branch and tag
git branch -D "${RELEASE_BRANCH}"
git tag -d "${RELEASE_TAG}"
```
This script does the following:

* Adds a comment to the release PR noting that it will be reverted
* Switches the work tree to the default branch so the release branch can be deleted
* Deletes the local release branch and release tag
* Deletes the remote release branch and release tag
* Deletes the release object created in GitHub for this release

Deleting the release branch on the remote will automatically close the release PR.

## FAQ

### How is the changelog updated?

Expand Down