Skip to content

Commit

Permalink
docs: add release doc (#333)
Browse files Browse the repository at this point in the history
Co-authored-by: Xander Grzywinski <xandergrzyw@gmail.com>
  • Loading branch information
ashnamehrotra and salaxander committed Sep 29, 2023
1 parent d2b0447 commit fbad7d1
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 1 deletion.
21 changes: 21 additions & 0 deletions website/docs/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Release Process
---

## 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
21 changes: 21 additions & 0 deletions website/versioned_docs/version-v0.4.x/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Release Process
---

## 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
3 changes: 2 additions & 1 deletion website/versioned_sidebars/version-v0.4.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"design",
"faq",
"contributing",
"code-of-conduct"
"code-of-conduct",
"release"
]
}

0 comments on commit fbad7d1

Please sign in to comment.