0.2.0 • Published 1 year ago

@contentlab/git-adapter-filesystem v0.2.0

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

Introduction

Contentlab is a library that generates a GraphQL content management API on top of a Git repository.

This repository holds code that implements a Contentlab 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 nameRequiredDefault valueDescription
checkedOutCommitHashTrueGit hash / revision currently checked out in the filesystem
pathSchemaFileFalseschema/schema.graphqlPath to schema file in repository
pathEntryFolderFalseentries/Path to folder for content entries

License

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