@commitspark/git-adapter-filesystem
TypeScript icon, indicating that this package has built-in type declarations

0.5.0 • Public • Published

Introduction

Commitspark is a workflow-first Content Management System based on Git and GraphQL.

This repository holds code that implements a Commitspark Git adapter for accessing content stored in a local filesystem.

This adapter is meant to be used in CI/CD pipelines where a single Git revision of content checked out in the filesystem needs to be read.

Usage

Instantiate the adapter with createAdapter() and then set adapter options FilesystemRepositoryOptions on the instance.

Option name Required Default value Description
checkedOutCommitHash True Git hash / revision currently checked out in the filesystem
pathSchemaFile False commitspark/schema/schema.graphql Path to schema file in repository
pathEntryFolder False commitspark/entries/ Path to folder for content entries

License

The code in this repository is licensed under the permissive ISC license (see LICENSE).

Readme

Keywords

none

Package Sidebar

Install

npm i @commitspark/git-adapter-filesystem

Weekly Downloads

2

Version

0.5.0

License

ISC

Unpacked Size

49.2 kB

Total Files

21

Last publish

Collaborators

  • advancingu