@commitspark/git-adapter-filesystem
v0.5.0
Published
Adapter that provides filesystem-based repository access to Commitspark
Downloads
32
Readme
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).