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

Jump to bottom

docs: add release doc #333

Merged
merged 4 commits into from
Sep 29, 2023
Merged

docs: add release doc #333

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
433dcda
add release doc
ashnamehrotra Sep 28, 2023
53f7875
move to website docs
ashnamehrotra Sep 28, 2023
0f7d0ed
add to sidebar and versioned docs for v0.4.0
ashnamehrotra Sep 28, 2023
02557f1
Merge branch 'main' into add-release-doc
salaxander Sep 29, 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
19 changes: 19 additions & 0 deletions docs/RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Release Process
Copy link
Member

Choose a reason for hiding this comment

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

should we move this to website docs so it's more visible? wdyt?

Copy link
Member

Choose a reason for hiding this comment

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

please make sure to add to sidebar


## Overview

The release process for Copacetic uses [GoReleaser](https://goreleaser.com/).

Once you are ready to cut a new release, checkout the release branch and tag it with the respective version.

```
git checkout <BRANCH NAME>
git pull origin <BRANCH NAME>
git tag -a <NEW VERSION> -m '<NEW VERSION>'
git push origin <NEW VERSION>
```

## Publishing

1. GoReleaser will create a new release, review and edit it at https://github.com/project-copacetic/copacetic/releases
2. Review the respective copa-action image at: https://github.com/orgs/project-copacetic/packages/container/package/copa-action