feat: publish the cli as snap #369

Karan-Palan · 2025-06-24T09:31:34Z

For linux based operating systems, the cli must be published as a snap on the snap store for automatic updates
This PR adds Snap packaging and automatons:

snap/snapcraft.yaml
• Uses cmake plugin to build the C++ CLI on core22.
• Dynamically adopts the version from the most-recent Git tag so each new tag pushes a fresh Snap revision.
• Exposes a strict-confinement
jsonschema
app with home and network plugs.
.github/workflows/snap.yml
• Builds the snap on every version tag (v*..) or manual dispatch.
• Stores the artifact and, when a tag build, publishes it to the Snap Store using a secret SNAPCRAFT_STORE_CREDENTIALS.

Signed-off-by: karan-palan <[email protected]>

.github/workflows/snap.yml

jviotti · 2025-06-24T18:57:07Z

.github/workflows/snap.yml

Can we extend the test workflow with a new snap entry that builds the Snap (but doesn't publish it) so that we make sure to never break the integration?

Also, can you add a new snap job on the package.yml action that will build the snap and build it as an artefact, and then extend the existing publish job to download the snap artefact and publish it (if it is a tag release)?

This file can go away then?

…allback to 0.00 version if no tags provided - Update snapcraft.yaml for building the JSON Schema CLI as a snap - Update GitHub Actions workflow for building and publishing snaps - Update CI to include snap building and testing - Add snap artifacts to .gitignore Signed-off-by: karan-palan <[email protected]>

Signed-off-by: karan-palan <[email protected]>

…ema into feat/publish-as-snap

…er to build snap sucessfully Signed-off-by: karan-palan <[email protected]>

jviotti · 2025-06-26T18:02:51Z

snapcraft.yaml

+
+    override-pull: |
+      craftctl default
+      VERSION=$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0")


You should fetch the version from CMakeLists.txt.

snapcraft.yaml

jviotti · 2025-06-26T18:03:45Z

snapcraft.yaml

+        -DCMAKE_SHARED_LIBRARY_LINK_C_FLAGS="-Wl,-Bstatic" \
+        -DCMAKE_SHARED_LIBRARY_LINK_CXX_FLAGS="-Wl,-Bstatic" \
+        $CRAFT_PART_SRC
+      cmake --build build --parallel "$(nproc)"


Suggested change

cmake --build build --parallel "$(nproc)"

cmake --build build --parallel "$(nproc)" --config Release

jviotti · 2025-06-26T18:04:25Z

snapcraft.yaml

+        -DCMAKE_SHARED_LIBRARY_LINK_CXX_FLAGS="-Wl,-Bstatic" \
+        $CRAFT_PART_SRC
+      cmake --build build --parallel "$(nproc)"
+      install -Dm755 build/src/jsonschema "$CRAFT_PART_INSTALL/bin/jsonschema"


You should be using cmake --install rather than manually pulling the binary out with install

jviotti · 2025-06-26T18:04:39Z

snapcraft.yaml

+    override-build: |
+      cmake -B build \
+        -DCMAKE_BUILD_TYPE=Release \
+        -DCMAKE_INSTALL_PREFIX=/usr \


Should this be $CRAFT_PART_INSTALL given what you had below?

Actually this is invalid. You should only pass the prefix when calling cmake --install below

jviotti · 2025-06-26T18:04:55Z

snapcraft.yaml

+
+    override-build: |
+      cmake -B build \
+        -DCMAKE_BUILD_TYPE=Release \


Suggested change

-DCMAKE_BUILD_TYPE=Release \

-DCMAKE_BUILD_TYPE:STRING=Release \

jviotti · 2025-06-26T18:05:56Z

snapcraft.yaml

+      cmake -B build \
+        -DCMAKE_BUILD_TYPE=Release \
+        -DCMAKE_INSTALL_PREFIX=/usr \
+        -DBUILD_SHARED_LIBS=OFF \


Suggested change

-DBUILD_SHARED_LIBS=OFF \

-DBUILD_SHARED_LIBS:BOOL=OFF \

jviotti · 2025-06-26T18:06:40Z

snapcraft.yaml

+
+summary: Command-line tool for working with JSON Schema
+description: |
+  The JSON Schema CLI is a comprehensive command-line utility for validating,


Can you use the exact same text as the GitHub repo description?

The CLI for working with JSON Schema. Covers formatting, linting, testing, bundling, and more for both local development and CI/CD pipelines

jviotti · 2025-06-26T18:07:15Z

.github/workflows/test.yml

+        uses: actions/upload-artifact@v4
+        with:
+          name: snap-${{ github.sha }}.snap
+          path: ${{ steps.snapcraft.outputs.snap }}


Can you also manually install the .snap file and run i.e. jsonschema version just to confirm it runs?

Or even better, assuming jsonschema will end up in the path, try to run one or two representative test cases from ./test, like:

./test/ci/pass_validate_http.sh jsonschema

Let me try this myself in the mean-time. I'll push a commit

.github/workflows/package.yml

jviotti · 2025-06-26T18:28:17Z

.gitignore

The entire project build happens in ./build to avoid polluting the project and having to ignore things out. Can you perform the build in ./build/snap? Not sure if snapcraft lets you put an output directory, but otherwise you can cd ./build/snap and call snap craft from there

jviotti · 2025-06-26T19:01:23Z

.github/workflows/package.yml

          merge-multiple: true

-      # Generate signed checksums for all pre-built binaries
+      # Generate signed checksums for all pre-built binaries and snaps


Snaps are prebuilt binaries anyway!

jviotti · 2025-06-26T19:02:34Z

.github/workflows/package.yml

@@ -167,6 +187,17 @@ jobs:
        with:
          node-version: '22.x'
          registry-url: 'https://registry.npmjs.org'
+      - name: Publish Snap to Snap Store


I propose we first publish the snaps to GitHub Releases. Once we make sure we got that right and that it all works well, we can look into publishing them to the official store. That way we can test all of this a few times before hitting the store for real

Signed-off-by: Juan Cruz Viotti <[email protected]>

jviotti · 2025-06-26T19:50:02Z

I added a commit on top of yours making a few adjustments and simplifying things a bit. The 3 follow-ups are:

While the CLI installs and runs the version command just fine, on CI, it fails to run actual validation. But it seems to work on my local Ubuntu machine. I will send another PR enabling a CI test that fails, in case you also want to look into it
Looks like we should be able to use the CMake Snap plugin given some minor parameter adjustments. I'll try to re-add that in another PR
So far, we only publish the Snaps to GitHub Releases. I want to make sure everything works OK before attempting to publish to the store

See: #369 Signed-off-by: Juan Cruz Viotti <[email protected]>

jviotti · 2025-06-26T19:52:22Z

See #371, in case you have any idea of what might be going off

jviotti · 2025-06-26T19:53:55Z

And this is the other one that I want to try to fix: #372

See: #369 Signed-off-by: Juan Cruz Viotti <[email protected]>

jviotti · 2025-06-26T20:55:11Z

OK, I think I fixed everything. I'm trying the first GitHub Release deployment and we'll see how that goes

jviotti · 2025-06-26T21:02:05Z

See https://github.com/sourcemeta/jsonschema/releases/tag/v9.4.0 for an initial GitHub Release. Thanks a lot for this! Let's give it a shot this week and if it all works fine, we'll publish to the store

Karan-Palan · 2025-06-27T07:57:05Z

See https://github.com/sourcemeta/jsonschema/releases/tag/v9.4.0 for an initial GitHub Release. Thanks a lot for this! Let's give it a shot this week and if it all works fine, we'll publish to the store

That's great news! I saw the changes you made, and everything's working perfectly now. It's much more simplified, which is a huge improvement. I wish I could've helped out, but I was asleep at the time. Anyway, I'm really looking forward to the CLI being available as a Snap and getting those automatic updates!

Karan-Palan added 2 commits June 24, 2025 14:58

feat: add snapcraft.yml to package the cli as snap

b85fb0b

Signed-off-by: karan-palan <[email protected]>

feat: create gh action to deploy newer versions of cli to snap store

8c70d64

Signed-off-by: karan-palan <[email protected]>

jviotti reviewed Jun 24, 2025

View reviewed changes

.github/workflows/snap.yml Outdated Show resolved Hide resolved

jviotti reviewed Jun 24, 2025

View reviewed changes

Karan-Palan and others added 8 commits June 25, 2025 14:23

fix: update snap build process to handle source directory correctly

1a7366c

Signed-off-by: karan-palan <[email protected]>

fix: update source path in snapcraft.yaml

6a20ece

Signed-off-by: karan-palan <[email protected]>

Merge branch 'sourcemeta:main' into feat/publish-as-snap

bf2bb3e

fix: point source outside snap dir; local build OK

3b33179

Signed-off-by: karan-palan <[email protected]>

Merge branch 'feat/publish-as-snap' of github.com:Karan-Palan/jsonsch…

628a2dd

…ema into feat/publish-as-snap

chore: move manifest to repo root and update CI points for gh contain…

5665c3f

…er to build snap sucessfully Signed-off-by: karan-palan <[email protected]>

chore: move manifest to repo root and update CI points for gh contain…

8417068

…er to build snap sucessfully Signed-off-by: karan-palan <[email protected]>

jviotti reviewed Jun 26, 2025

View reviewed changes

snapcraft.yaml Outdated Show resolved Hide resolved

jviotti reviewed Jun 26, 2025

View reviewed changes

.github/workflows/package.yml Outdated Show resolved Hide resolved

jviotti reviewed Jun 26, 2025

View reviewed changes

jviotti force-pushed the feat/publish-as-snap branch from 51a83ce to a4665b3 Compare June 26, 2025 18:51

jviotti reviewed Jun 26, 2025

View reviewed changes

jviotti force-pushed the feat/publish-as-snap branch 4 times, most recently from 4abab45 to c140b3a Compare June 26, 2025 19:42

jviotti

c190184

Signed-off-by: Juan Cruz Viotti <[email protected]>

jviotti force-pushed the feat/publish-as-snap branch from c140b3a to c190184 Compare June 26, 2025 19:45

jviotti merged commit 3f28bfe into sourcemeta:main Jun 26, 2025
10 checks passed

jviotti added a commit that referenced this pull request Jun 26, 2025

Run an actual validating test for the new Ubuntu Snap

beb7e1a

See: #369 Signed-off-by: Juan Cruz Viotti <[email protected]>

jviotti mentioned this pull request Jun 26, 2025

Run an actual validating test for the new Ubuntu Snap #371

Merged

jviotti added a commit that referenced this pull request Jun 26, 2025

Run an actual validating test for the new Ubuntu Snap

3511967

See: #369 Signed-off-by: Juan Cruz Viotti <[email protected]>

jviotti added a commit that referenced this pull request Jun 26, 2025

Run an actual validating test for the new Ubuntu Snap

54ea884

See: #369 Signed-off-by: Juan Cruz Viotti <[email protected]>

jviotti added a commit that referenced this pull request Jun 26, 2025

Run an actual validating test for the new Ubuntu Snap

b33391f

See: #369 Signed-off-by: Juan Cruz Viotti <[email protected]>

jviotti added a commit that referenced this pull request Jun 26, 2025

Run an actual validating test for the new Ubuntu Snap (#371)

1943c92

See: #369 Signed-off-by: Juan Cruz Viotti <[email protected]>

Karan-Palan deleted the feat/publish-as-snap branch June 27, 2025 07:55

	cmake --build build --parallel "$(nproc)"
	cmake --build build --parallel "$(nproc)" --config Release

	-DCMAKE_BUILD_TYPE=Release \
	-DCMAKE_BUILD_TYPE:STRING=Release \

feat: publish the cli as snap #369

feat: publish the cli as snap #369

Uh oh!

Conversation

Karan-Palan commented Jun 24, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jviotti commented Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jviotti commented Jun 26, 2025

Uh oh!

jviotti commented Jun 26, 2025

Uh oh!

jviotti commented Jun 26, 2025

Uh oh!

jviotti commented Jun 26, 2025

Uh oh!

Karan-Palan commented Jun 27, 2025

Uh oh!

Uh oh!

jviotti commented Jun 26, 2025 •

edited

Loading