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.

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

Make the cli available as a snap #304

Merged
merged 3 commits into from
Dec 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -134,3 +134,20 @@ jobs:
run: |
docker manifest push containrrr/shoutrrr:${GITHUB_REF/refs\/tags\/v/} && \
docker manifest push containrrr/shoutrrr:latest
snap:
name: Build Shoutrrr snap
runs-on: ubuntu-latest
needs: build
steps:
- uses: actions/checkout@v2
name: Checkout repository
- uses: snapcore/action-build@v1
name: Build snap
id: build
- uses: snapcore/action-publish@v1
name: Release snap
env:
SNAPCRAFT_STORE_CREDENTIALS: ${{ secrets.STORE_LOGIN }}
with:
snap: ${{ steps.build.outputs.snap }}
release: edge
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
*.so
*.dylib
/shoutrrr/shoutrrr
*.snap

# Test binary, build with `go test -c`
# ---
Expand Down
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,26 @@ Heavily inspired by <a href="https://github.com/caronc/apprise">caronc/apprise</
</div>
<br/><br/>

## Installation

### Using the snap

```bash
$ sudo snap install shoutrrr
```

### Using the Go CLI

```bash
$ go install github.com/containrrr/shoutrrr@latest
```

### From Source

```bash
$ go build -o shoutrrr .
```

## Quick Start

### As a package
Expand Down
31 changes: 31 additions & 0 deletions snap/snapcraft.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: shoutrrr
base: core22
version: '0.6.1'
summary: Sending notifications made easy.
description: |
Shoutrrr is a way of making the sending of notifications easy by standardizing it.
grade: stable
confinement: strict
contact: https://github.com/containrrr/shoutrrr/discussions
issues: https://github.com/containrrr/shoutrrr/issues
icon: docs/shoutrrr-logotype.png
license: MIT
source-code: https://github.com/containrrr/shoutrrr
type: app
compression: lzo


apps:
shoutrrr:
command: bin/shoutrrr

parts:
shoutrrr:
plugin: go
source: .
source-type: git
build-packages:
- golang
build-environment:
- CGO_ENABLED: 0