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.

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

docs: update unclog instructions #1481

Merged
merged 2 commits into from
Dec 6, 2023
Merged

docs: update unclog instructions #1481

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33a4dc9
update unclog instructions
mpoke Dec 5, 2023
aab11b6
Merge branch 'main' into marius/release-process
mpoke Dec 6, 2023
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: 7 additions & 0 deletions RELEASE_PROCESS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,13 @@ Before cutting a _**release candidate**_ (e.g., `v3.3.0-rc0`), the following ste
```bash
unclog release v3.3.0
```
- `unclog release` requires an editor. This can be set either by configuring
an `$EDITOR` environment variable or by manually specify an editor binary path
via the `--editor` flag.
- add the date as the summary of the release (`unclog release` requires adding a summary), e.g.,
```md
*December 5, 2023*
```
Copy link
Contributor

@p-offtermatt p-offtermatt Dec 5, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Is it worth adding, to avoid any confusion, that this is the only thing that should be added here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's not always the only thing, but in general, this should be enough.

- update `CHANGELOG.md`, i.e.,
```bash
unclog build > CHANGELOG.md
Expand Down
Loading