Snap created and published

.github/workflows/test-snap-can-build.yml

@@ -0,0 +1,28 @@
+name: 🧪 Test snap can be built on x86_64
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x] # Are you are missing this specification?
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: snapcore/action-build@v1
+        id: build
+
+      - uses: diddlesnaps/snapcraft-review-action@v1
+        with:
+          snap: ${{ steps.build.outputs.snap }}
+          isClassic: 'false'
+          # Plugs and Slots declarations to override default denial (requires store assertion to publish)
+          # plugs: ./plug-declaration.json
+          # slots: ./slot-declaration.json

.gitignore

@@ -9,3 +9,18 @@ target/
 /tests/fixtures/commit-graphs/
 
 **/generated-do-not-edit/
+
+# gitginore template for creating Snap packages
+# website: https://snapcraft.io/
+
+parts/
+prime/
+stage/
+*.snap
+
+# Snapcraft global state tracking data(automatically generated)
+# https://forum.snapcraft.io/t/location-to-save-global-state/768
+/snap/.snapcraft/
+
+# Source archive packed by `snapcraft cleanbuild` before pushing to the LXD container
+/*_source.tar.bz2

README.md

@@ -2,6 +2,8 @@
 [![Crates.io](https://img.shields.io/crates/v/gitoxide.svg)](https://crates.io/crates/gitoxide)
 <img src="etc/msrv-badge.svg">
 
+[![gitoxide](https://snapcraft.io/gitoxide/badge.svg)](https://snapcraft.io/gitoxide)
+
 `gitoxide` is an implementation of `git` written in Rust for developing future-proof applications which strive for correctness and
 performance while providing a pleasant and unsurprising developer experience. 
 
@@ -177,6 +179,15 @@ For Arch Linux you can download `gitoxide` from `community` repository:
 pacman -S gitoxide
 ```
 
+### Install the snap:
+
+For latest builds, based on most recent commits to `main` branch, use the `edge` channel.
+
+```
+sudo snap install gitoxide
+```
+To run it from your terminal, type: `gix` or `ein` to access either binary in the `gitoxide` suite
+
 ### From Source via Cargo
 
 `cargo` is the Rust package manager which can easily be obtained through [rustup]. With it, you can build your own binary

snap/snapcraft.yaml

@@ -0,0 +1,67 @@
+name: gitoxide
+adopt-info: gitoxide
+summary: gitoxide is an implementation of git written in Rust
+description: |
+    gitoxide is an implementation of git written in Rust for developing future-proof applications 
+    which strive for correctness and performance while providing a pleasant and unsurprising 
+    developer experience.
+    gitoxide provides the gix and ein binaries for use on the command-line to allow experimentation
+    with key features like fetch and clone, and to validate the usability and control of the API
+    offered by the gix crate.
+    gitoxide aspires to be a production-grade server implementation and the ein binary aspires to
+    become the default way to interact with git repositories. 
+
+    To run it from your terminal, type: `gix` or `ein` to access binaries in the `gitoxide` suite
+
+license: Apache-2.0
+
+base: core20
+grade: stable
+confinement: strict
+compression: lzo
+
+apps:
+  gitoxide:
+    command: bin/gix
+    environment:
+      PATH: $SNAP/bin/:$PATH       
+    plugs:
+      - network
+      - home
+
+  ein:
+    command: bin/ein
+    environment:
+      PATH: $SNAP/bin/:$PATH       
+    plugs:
+      - network
+      - home
+
+parts:
+  gitoxide:
+    source: https://github.com/Byron/gitoxide
+    source-type: git
+    plugin: rust
+    after: [cargo]
+
+    override-pull: |
+      snapcraftctl pull
+      snapcraftctl set-version "$(git describe --tags | sed 's/^v//' | cut -d "-" -f3)"
+
+    build-packages:
+      - cmake
+
+  cargo:
+    source: https://github.com/rust-lang/cargo
+    source-type: git
+    plugin: rust
+
+    override-pull: |
+      snapcraftctl pull
+      snapcraftctl set-version "$(git describe --tags | sed 's/^v//' | cut -d "-" -f2)"
+
+    build-packages:
+      - cargo
+      - rustc
+      - pkg-config
+      - librust-openssl-sys-dev