gatsby-source-sanity vs upload-artifact

Our great sponsors

SurveyJS - Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App

InfluxDB - Power Real-Time Data Analytics at Scale

WorkOS - The modern identity platform for B2B SaaS

Our great sponsors

gatsby-source-sanity		upload-artifact
	Project
15	Mentions	24
196	Stars	2,863
0.0%	Growth	2.9%
6.8	Activity	8.1
5 days ago	Latest Commit	9 days ago
TypeScript	Language	TypeScript
MIT License	License	MIT License

The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.

gatsby-source-sanity

Posts with mentions or reviews of gatsby-source-sanity. We have used some of these posts to build our list of alternatives and similar projects. The last one was on 2022-09-06.

Prismic CMS Limitations/Bugs?
3 projects | /r/gatsbyjs | 6 Sep 2022

I linked to the image issue in my post: https://github.com/sanity-io/gatsby-source-sanity/issues/174

3 projects | /r/gatsbyjs | 6 Sep 2022

I mentioned in another reply that the issue with images was within rich text, using the Portal text package. As I out described in my issue, it's not an issue of docs. GatsbyImageData is not output in the graphql, just a _ref which appears to be the filename without any path or domain. GatsbyImageData is used to process the image so if a content editor throws in a 2000px wide image, I can use that output to make a smaller image.

3 projects | /r/gatsbyjs | 6 Sep 2022

There's a weird edge case where gatsbyImageData doesn't come through the rich text content type and setup was a huge pain in the ass.
What CMS system do you use for E-com sites or blogs.
2 projects | /r/reactjs | 1 Jun 2021

I'm currently building a site with React and Next.js, and I'm having a good experience with Sanity so far.
Form validation with Yup
3 projects | dev.to | 21 Apr 2021

In this article, we will build a small application that allows customers to leave product reviews for an e-commerce website. We will build the web application with React while the content (and back end) will be hosted on Sanity. Communication between the web application and back end will be via Graph-Relational Object Queries (GROQ).
Can anybody recommend a headless CMS for a full stack vue/node project?
3 projects | /r/vuejs | 10 Apr 2021
Why Typescript and Svelte are a match made in heaven
7 projects | dev.to | 2 Apr 2021
Note: If you want to follow along with styling, you can replace public/globals.css with the full example code, and also pull contents from individual component, like this one.

Render (Static) Inaction Cards

To bring it to life on the home page, adjust the default intro copy and render a few inactions from the main src/App.svelte component.
```

 import InactionCard from "./components/InactionCard.svelte";



 To Don't List
 class="intro">Here is a list of things I'm not going to do:

 
 title="Return VHS to Blockbuster"
 notes="You've had it since 1998. What's the rush?"
 />
 
 title="Fix the hole in the wall"
 notes="Keeping it where it is adds character and nostalgia."
 />
 
 title="Do the dishes"
 notes="Someone else will probably get to them. Just leave them in the sink."
 />
```
Enter fullscreen mode Exit fullscreen mode
Take a look back at your browser and you should see the list! (Refresh if you don't.)

There we go! We have a (very simple) Svelte app with just HTML, CSS, and JavaScript.

Adding TypeScript to a Svelte project

Now, suppose we wanted to add a due date. It's not too difficult in this example, right? Let's do it!

We add a new property to the Inaction Card component:
```

 export let title, notes, dueDate;


 class="inaction">
 class="title">{title}
 class="due-date">{dueDate}
 class="notes">{notes}
```
Enter fullscreen mode Exit fullscreen mode

And to the inactions we render, we can add the new prop:
```
 title="Return VHS to Blockbuster"
 dueDate={new Date("1992-02-29")}
 notes="You've had it since 1998. What's the rush?"
/>

 title="Fix the hole in the wall"
 dueDate={Date.now()}
 notes="Keeping it where it is adds character and nostalgia."
/>

 title="Do the dishes"
 dueDate={new Date("2024-02-29")}
 notes="Someone else will probably get to them. Just leave them in the sink."
/>
```
Enter fullscreen mode Exit fullscreen mode
Then jump back over to your browser:

Notice anything weird? I do. Two things, actually:
1. The first and the third inactions display an unnecessarily-long date. That could have been easily formatted, but we're not going to worry about that here.
2. The second date is a number. That's a bigger issue, and I'll explain why.
What if, we rendered the type of dueDate instead? (i.e. typeof dueDate)

We get number for the second one! Even with this small of an application that could absolutely be an issue. Suppose you wanted to better control the formatting of the date. You'd have to first introspect the type of date and then format appropriately. It'd be much easier if we know (with confidence) what type to expect.

TypeScript Saves the Day!

We can use TypeScript to tell our application exactly what we expect in dueDate.

Since our Svelte app is still largely untouched, we can use the built-in utility to convert it to TypeScript. Shut down your development server (ctrl+c), and then run the following commands:
```
$ node scripts/setupTypeScript.js
$ npm install
```
Enter fullscreen mode Exit fullscreen mode
This made several changes, but the most important one is that you now need to specify the language in your </code> tags as <code>ts</code>. Take a look at the change in <code>src/App.svelte</code>: <div class="highlight js-code-highlight"> <pre class="highlight html"><code> <script lang="ts"> </code></pre> <div class="highlight__panel js-actions-panel"> <div class="highlight__panel-action js-fullscreen-code-action"> <svg xmlns="http://www.w3.org/2000/svg" width="20px" height="20px" viewbox="0 0 24 24" class="highlight-action crayons-icon highlight-action--fullscreen-on"><title>Enter fullscreen mode</title> <path d="M16 3h6v6h-2V5h-4V3zM2 3h6v2H4v4H2V3zm18 16v-4h2v6h-6v-2h4zM4 19h4v2H2v-6h2v4z"></path> </svg> <svg xmlns="http://www.w3.org/2000/svg" width="20px" height="20px" viewbox="0 0 24 24" class="highlight-action crayons-icon highlight-action--fullscreen-off"><title>Exit fullscreen mode</title> <path d="M18 7h4v2h-6V3h2v4zM8 9H2V7h4V3h2v6zm10 8v4h-2v-6h6v2h-4zM8 15v6H6v-4H2v-2h6z"></path> </svg> </div> </div> </div> Make this change to your Inaction Card component. <h3> <a name="dry-up-inactions" href="#dry-up-inactions" class="anchor"> </a> DRY Up Inactions </h3> To make this adjustment process smoother, let's <a href="https://en.wikipedia.org/wiki/Don%27t_repeat_yourself">DRY up</a> our code. Adjust your <code>App.svelte</code> to loop through an array of inactions that we create in the <code><script></code> section. <div class="highlight js-code-highlight"> <pre class="highlight html"><code> <script lang="ts"> import InactionCard from "./components/InactionCard.svelte"; let inactions = [ { title: "Return VHS to Blockbuster", dueDate: new Date("1992-02-29"), notes: "You've had it since 1998. What's the rush?", }, { title: "Fix the hole in the wall", dueDate: Date.now(), notes: "Keeping it where it is adds character and nostalgia.", }, { title: "Do the dishes", dueDate: new Date("2024-02-29"), notes: "Someone else will probably get to them. Just leave them in the sink.", }, ]; 
To Don't List class="intro">Here is a list of things I'm not going to do: {#each inactions as inaction} title={inaction.title} dueDate={inaction.dueDate} notes={inaction.notes} /> {/each}

Enter fullscreen mode Exit fullscreen mode

Define Inaction Type

TypeScript is really all about types. (It's in the name, after all!) To add types in a Svelte project, we'll want a separate .ts file. Let's put our types in a types directory, just to stay organized.
```
// src/types/Inaction.ts
export interface Inaction {
 title: string;
 dueDate: Date;
 notes: string;
}
```
Enter fullscreen mode Exit fullscreen mode
This tells us that when we set an object as an Inaction, we expect it to have title and notes as a string, and dueDate as a Date.

To use it, import the type and then note it. The syntax is a little goofy at first, but you'll get the hang of it.
```
lang="ts">
 import type { Inaction } from "./types/Inaction";
 import InactionCard from "./components/InactionCard.svelte";

 // inactions should be an array of items with the Inaction type.
 let inactions: Inaction[] = [
 {
 title: "Return VHS to Blockbuster",
 dueDate: new Date("1992-02-29"),
 notes: "You've had it since 1998. What's the rush?",
 },
 {
 title: "Fix the hole in the wall",
 dueDate: Date.now(),
 notes: "Keeping it where it is adds character and nostalgia.",
 },
 {
 title: "Do the dishes",
 dueDate: new Date("2024-02-29"),
 notes:
 "Someone else will probably get to them. Just leave them in the sink.",
 },
 ];

```
Enter fullscreen mode Exit fullscreen mode
After I restarted my code editor (VS Code), it told me something was wrong!

This says dueDate on the second inaction is the wrong type!

The power in this is great! VS Code told me there's an issue with the code without having to open up the browser!

If that's useful even on this small scale, imagine how helpful it would be in a large application where Inaction may be used dozens or hundreds of times!

Validating Types

Aside from the code editor adding little squiggles, nothing would actually appear wrong during the Svelte build. Fortunately, Svelte gives us a tool to make sure everything is okay, svelte-check.

Try running the following command:
```
$ npx svelte-check
```
Enter fullscreen mode Exit fullscreen mode
I see an error and three warnings:
```
Loading svelte-check in workspace: .../to-dont-list
Getting Svelte diagnostics...
====================================

.../to-dont-list/src/App.svelte:13:7
Error: Type 'number' is not assignable to type 'Date'. (ts)
 title: "Fix the hole in the wall",
 dueDate: Date.now(),
 notes: "Keeping it where it is adds character and nostalgia.",

.../to-dont-list/src/components/InactionCard.svelte:2:14
Hint: Variable 'title' implicitly has an 'any' type, but a better type may be inferred from usage. (ts)

 export let title, notes, dueDate;


.../to-dont-list/src/components/InactionCard.svelte:2:21
Hint: Variable 'notes' implicitly has an 'any' type, but a better type may be inferred from usage. (ts)

 export let title, notes, dueDate;


.../to-dont-list/src/components/InactionCard.svelte:2:28
Hint: Variable 'dueDate' implicitly has an 'any' type, but a better type may be inferred from usage. (ts)

 export let title, notes, dueDate;
```
Enter fullscreen mode Exit fullscreen mode
You can wire up this command to your build process so you don't send invalid typed code to production. Amazing!

I hope this validates (😉) the use of TypeScript and Svelte enough to entice you to try it out for yourself! But before we go, let's take a look at wiring this up to Sanity so that we can pull in data dynamically from an external source.

Wiring up Sanity to a Svelte project

To get Sanity up and running, begin by installing the CLI and bootstrapping a new project.
```
$ npm install -g @sanity/cli
$ sanity init
```
Enter fullscreen mode Exit fullscreen mode
After authenticating, choose the appropriate items to get your project started. These were my choices:
- Select project to use: Create a new project
- Your project name: To Not Do
- Use the default dataset configuration? Yes
- Project output path: (Use recommendation)
- Select project template: Clean project with no predefined schemas
That will install dependencies and prepare a Studio project. You should now be able to change into the new directory Sanity created for you and start the Studio.
```
$ cd path/to/new/directory
$ npm start
```
Enter fullscreen mode Exit fullscreen mode
By default, the Studio will be available in your browser at http://localhost:3333/. You'll have to sign in again. And when you do, you should see that you have an empty schema.

Add Data Model

Let's create our data model, which Sanity calls a document type. If you're not familiar with Sanity, here's a nice overview of content modeling.

To add our model, we're going to edit the (nearly) blank schema file Sanity gave us. This file lives in schemas/schema.js. It should look something like this:
```
// First, we must import the schema creator
import createSchema from "part:@sanity/base/schema-creator";

// Then import schema types from any plugins that might expose them
import schemaTypes from "all:part:@sanity/base/schema-type";

// Then we give our schema to the builder and provide the result to Sanity
export default createSchema({
 // We name our schema
 name: "default",
 // Then proceed to concatenate our document type
 // to the ones provided by any plugins that are installed
 types: schemaTypes.concat([
 /* Your types here! */
 ]),
});
```
Enter fullscreen mode Exit fullscreen mode
We're going to put our type in the types object. Let's create an inaction model with the proper fields:
```
import createSchema from "part:@sanity/base/schema-creator";
import schemaTypes from "all:part:@sanity/base/schema-type";

export default createSchema({
 name: "default",
 types: schemaTypes.concat([
 {
 title: "Inaction",
 name: "inaction",
 type: "document",
 fields: [
 { title: "Title", name: "title", type: "string" },
 { title: "Notes", name: "notes", type: "text" },
 { title: "Due Date", name: "dueDate", type: "date" },
 ],
 },
 ]),
});
```
Enter fullscreen mode Exit fullscreen mode
Notice that if you go back to your browser, Studio already picked up your changes! (Science! Or something?)

Use your new model to recreate the static content from src/App.svelte.

Pull in Data Dynamically

Once that content is in place, we can pull it into project. First, install Sanity's JavaScript client.
```
$ npm install @sanity/client
```
Enter fullscreen mode Exit fullscreen mode
Then we can make some changes to the </code> in our <code>App.svelte</code> component to fetch our inactions from the Sanity API. <div class="highlight js-code-highlight"> <pre class="highlight html"><code> <script lang="ts"> import { onMount } from "svelte"; import sanityClient from "@sanity/client"; import type { Inaction } from "./types/Inaction"; import InactionCard from "./components/InactionCard.svelte"; // Create a client to connect to the Sanity datastore. const sanity = sanityClient({ apiVersion: 'v2021-03-25', projectId: "...", dataset: "production", useCdn: false, }); // Initialize our inactions as an empty array. let inactions: Inaction[] = []; // Fetch the inactions from Sanity, and replace the array. async function fetchInactions() { const query = '*[_type == "inaction"]{ _id, title, notes, dueDate }'; inactions = await sanity.fetch(query); } // Run the fetch function when the component is ready (mounted). onMount(fetchInactions); 

Enter fullscreen mode Exit fullscreen mode

And now you are reading dynamic data for the list of things you're never going to have to do!

Next Steps

I hope you are intrigued enough by this to to tinker with these super cool tools! And if you want to keep going with this example, here are some ideas on where to go next:
- Add a form to submit new Inaction objects to Sanity. (The demo and its code have a working example.) Note: If you go this route, you'll want to start thinking about authenticating your API requests.
- Deploy the project to a build and hosting service, like Vercel.
- Deploy Sanity Studio so you can make edits in Sanity, without having to run the Studio locally.
I'd love to learn where you choose to take your project. The things we can build with Svelte, TypeScript, and Sanity are endless! Let's chat!

Last, here are a few other resources for further reading on Svelte + TypeScript:
- Svelte and TypeScript - Together at last! (Scott Logic)
- TypeScript support in Svelte (MDN)
- Integrating TypeScript with Svelte (CSS-Tricks)
- Svelte <3 TypeScript (Svelte)
Sanity Backup Function with GitHub Actions and Artifacts
4 projects | dev.to | 2 Apr 2021

Sanity.io is a platform to build websites and applications. It comes with great APIs that let you treat content like data. Give your team exactly what they need to edit and publish their content with the customizable Sanity Studio. Get real-time collaboration out of the box. Sanity.io comes with a hosted datastore for JSON documents, query languages like GROQ and GraphQL, CDNs, on-demand asset transformations, presentation agnostic rich text, plugins, and much more.
On the limits of MDX
9 projects | dev.to | 1 Apr 2021

I get it. I get the tangibility of flat files. I get that it feels good to take your coding skills into your prose. But it's not the best way to work with content. Text editors with familiar affordances that produce typed rich text that can be queried and serialized into whatever you need are better. Where developers can define the data structures they need, and editors get easy-to-use tools to get their work done. Like what we're building at Sanity with Portable Text.
GraphQL vs REST: which API is better for your web app?
2 projects | dev.to | 30 Mar 2021

Sanity.io offers an open-source query language called GROQ (Graph-Relational Object Queries). It allows us to describe what information we want in our application, join data from different documents, and generate a response with only the information that is needed.

upload-artifact

Posts with mentions or reviews of upload-artifact. We have used some of these posts to build our list of alternatives and similar projects. The last one was on 2024-02-01.

Learning GitHub Actions in a Simple Way
5 projects | dev.to | 1 Feb 2024

upload-artifact
GitHub Actions for Jar file deployment
2 projects | dev.to | 13 Jan 2024

Here, the concept of "upload" is a little confusing. What the GitHub action upload-artifact does is to "copy" the jar file to a publicly accessible folder.
CI/CI deploy a static website to AWS S3 bucket through Github Actions
5 projects | dev.to | 22 Dec 2023

The content of the build destination folder folder needs is saved and transferred to the following jobs in the workflow. We do this with the Github actions actions/upload-artifact
Building project docs for GitHub Pages
7 projects | dev.to | 29 Aug 2023

The action for uploading the artifact doesn't do too much, but it takes care of all the nuance around GitHub Pages artifacts specifically. You can view the action's source here. It will tar the path (provided by the with option) and then call the upload artifact action. The artifact's name is github-pages and has a 1 day expiration. This artifact has the name and format required for the deploy action. It all just works (so far).
A guide to using act with GitHub Actions
5 projects | dev.to | 23 Mar 2023

➜ getting-started-with-act git:(master) act -j build WARN ⚠ You are using Apple M1 chip and you have not specified container architecture, you might encounter issues while running act. If so, try running it with '--container-architecture linux/amd64'. ⚠ [Node.js CI/build] 🚀 Start image=node:16-buster-slim [Node.js CI/build] 🐳 docker pull image=node:16-buster-slim platform= username= forcePull=false [Node.js CI/build] 🐳 docker create image=node:16-buster-slim platform= entrypoint=["tail" "-f" "/dev/null"] cmd=[] [Node.js CI/build] 🐳 docker run image=node:16-buster-slim platform= entrypoint=["tail" "-f" "/dev/null"] cmd=[] [Node.js CI/build] ☁ git clone 'https://github.com/actions/setup-node' # ref=v3 [Node.js CI/build] ☁ git clone 'https://github.com/actions/cache' # ref=v3 [Node.js CI/build] ☁ git clone 'https://github.com/actions/upload-artifact' # ref=v3 [Node.js CI/build] ⭐ Run Main actions/checkout@v3 [Node.js CI/build] 🐳 docker cp src=/Users/andrewevans/Documents/projects/getting-started-with-act/. dst=/Users/andrewevans/Documents/projects/getting-started-with-act [Node.js CI/build] ✅ Success - Main actions/checkout@v3 [Node.js CI/build] ⭐ Run Main Use Node.js 16.x [Node.js CI/build] 🐳 docker cp src=/Users/andrewevans/.cache/act/actions-setup-node@v3/ dst=/var/run/act/actions/actions-setup-node@v3/ [Node.js CI/build] 🐳 docker exec cmd=[node /var/run/act/actions/actions-setup-node@v3/dist/setup/index.js] user= workdir= [Node.js CI/build] 💬 ::debug::isExplicit: [Node.js CI/build] 💬 ::debug::explicit? false
Using Github Actions to publish your Flutter APP to Firebase App Distribution
5 projects | dev.to | 4 Jan 2023

Notice that already known commands like flutter pub get and flutter build apk (apk in case of Android; aab in case of iOS) now it shows up on our workflow. But, to upload the generated app file (artifact), we'll need to use the action upload-artifact@v1 and parse the build path which it will be storing the app file.
github action para deploy de app vuejs 3
2 projects | dev.to | 5 Dec 2022
How do I write the GitHub release workflow for multiple OSs?
3 projects | /r/github | 22 Oct 2022

So the uploading will likely be done by upload artifact. Then you'll likely want to use a matrix build/package your tool across different OS's.
Automate Android Build Using GitHub Actions
6 projects | dev.to | 19 Sep 2022

Artifacts are files like APKs, screenshots, test reports, logs, which the workflow generates. You can upload and download artifacts to the current workflow using actions/upload-artifact@v2 and actions/download-artifact@v2 respectively.
How Fastly manages its software with GitHub Actions
15 projects | dev.to | 31 Aug 2022

Artifacts: actions/upload-artifact, actions/download-artifact.

What are some alternatives?

When comparing gatsby-source-sanity and upload-artifact you can also consider the following projects:

cache - Cache dependencies and build outputs in GitHub Actions

jacoco-badge-generator - Coverage badges, and pull request coverage checks, from JaCoCo reports in GitHub Actions

publish-unit-test-result-action - GitHub Action to publish unit test results on GitHub

flutter-action - Flutter environment for use in GitHub Actions. It works on Linux, Windows, and macOS.

Publii - The most intuitive Static Site CMS designed for SEO-optimized and privacy-focused websites.

github-action-sanity

metadata-action - GitHub Action to extract metadata (tags, labels) from Git reference and GitHub events for Docker

codecov-action - GitHub Action that uploads coverage to Codecov :open_umbrella:

rust-ci-github-actions-workflow - Rust project template with CI workflow in GitHub Actions

Strapi - 🚀 Strapi is the leading open-source headless CMS. It’s 100% JavaScript/TypeScript, fully customizable and developer-first.

build-push-action - GitHub Action to build and push Docker images with Buildx

setup-node - Set up your GitHub Actions workflow with a specific version of node.js

upload-artifact vs cache upload-artifact vs jacoco-badge-generator upload-artifact vs publish-unit-test-result-action upload-artifact vs flutter-action gatsby-source-sanity vs Publii upload-artifact vs github-action-sanity upload-artifact vs metadata-action upload-artifact vs codecov-action upload-artifact vs rust-ci-github-actions-workflow gatsby-source-sanity vs Strapi upload-artifact vs build-push-action upload-artifact vs setup-node

Compare gatsby-source-sanity vs upload-artifact and see what are their differences.

gatsby-source-sanity

upload-artifact

gatsby-source-sanity

Render (Static) Inaction Cards

To Don't List

Adding TypeScript to a Svelte project

TypeScript Saves the Day!

To Don't List

Define Inaction Type

Validating Types

Wiring up Sanity to a Svelte project

Add Data Model

Pull in Data Dynamically

Next Steps

upload-artifact

What are some alternatives?