Skip to content

Commit

Permalink
Removing the GitHub Action release workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
marccampbell committed Oct 17, 2024
1 parent 3e86139 commit 04061c1
Show file tree
Hide file tree
Showing 7 changed files with 2 additions and 175 deletions.
95 changes: 0 additions & 95 deletions .github/workflows/release.yml

This file was deleted.

7 changes: 0 additions & 7 deletions .goreleaser.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,3 @@ archives:
- CHANGELOG*
snapshot:
version_template: SNAPSHOT-{{ .Commit }}
dockers:
- dockerfile: deploy/Dockerfile
image_templates:
- "replicated/vendor-cli:latest"
- "replicated/vendor-cli:{{ .Major }}"
- "replicated/vendor-cli:{{ .Major }}.{{ .Minor }}"
- "replicated/vendor-cli:{{ .Major }}.{{ .Minor }}.{{ .Patch }}"
46 changes: 1 addition & 45 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,6 @@
# Contributing

All you need is a computer with Go installed, and a Replicatd account to test with.

### Updating Goreleaser / Testing Homebrew updates

#### How releases work

In general, push a SemVer tag to the repo on the `main` branch and a GitHub action will trigger, invoking [goreleaser](https://goreleaser.com/) to create the necessary artifacts including go binaries, docker images, and homebrew tap updates. Binaries are availabled on the [releases page](https://github.com/replicatedhq/replicated/releases).

Goreleaser is configured to push updates to our [Hombebrew Tap](https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap) at https://github.com/replicatedhq/homebrew-replicated.

These can be installed with

```
# preferred method, more clear
brew install replicatedhq/replicated/cli
# later
brew upgrade replicatedhq/replicated/cli
```
or

```
# alternative method. less typing but also less clear, esp on upgrades
brew tap replicatedhq/replicated
brew install cli
# later
brew upgrade cli
```
#### Testing goreleaser locally

You can test the artifacts goreleaser will create locally!

1. Install [goreleaser](https://goreleaser.com/install/) using `brew install goreleaser`
2. Run `goreleaser release --snapshot --rm-dist`.
3. Check the artifacts created under `dist/`
1. Check `cli.rb` and make sure it has the expected content.
2. Check the `replicated_SNAPSHOT-*.tar.gz` files and by using `tar -tvf` making sure they contain the `replicated` binary.
3. Optionally, follow the instructions below to test your created `cli.rb` with `brew install` or `brew upgrade` by copying it into your tap cache.

#### Testing homebrew tap changes locally

You can edit the tap file directly in your local homebrew cache. E.g. mine is checked out at /Users/dex/homebrew/Library/Taps/replicatedhq/homebrew-replicated/. By editing those files and running e.g. `brew upgrade replicatedhq/replicated/cli`, you can verify the changes.

If you want to allow others to test your homebrew-only changes (that is, just changes to the ruby file) without you needing to create a full release via goreleaser, you can also edit the file in the github repo. Testers may need to `rm -r` their locally cached checkout of the tap (e.g. `rm -r /Users/dex/homebrew/Library/Taps/replicatedhq/homebrew-replicated/`) before running `brew install` or `brew upgrade`.
All you need is a computer with Go installed, and a Replicated account to test with.

### Design

Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM golang:1.20
FROM golang:1.22

ENV PROJECTPATH=/go/src/github.com/replicatedhq/replicated

Expand Down
9 changes: 0 additions & 9 deletions deploy/Dockerfile

This file was deleted.

12 changes: 0 additions & 12 deletions examples/enterprise/replicas.opa

This file was deleted.

6 changes: 0 additions & 6 deletions hack/Dockerfile.testing

This file was deleted.

0 comments on commit 04061c1

Please sign in to comment.