Introduction

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

This repository holds code that implements access to Git repositories hosted on GitHub.

Usage

Instantiate the adapter with createAdapter() and then call setRepositoryOptions() with GitHubRepositoryOptions on the instance. These options are as follows:

Option name	Required	Default value	Description
repositoryOwner	True		GitHub repository owner, e.g. commitspark
repositoryName	True		GitHub repository name, e.g. git-adapter-github
personalAccessToken	True		GitHub personal access token (see details below)
pathSchemaFile	False	commitspark/schema/schema.graphql	Path to schema file in repository
pathEntryFolder	False	commitspark/entries/	Path to folder for content entries

Personal Access Token

Both "Tokens (classic)" and "Fine-grained tokens" are supported. See the GitHub documentation.

Tokens (classic)

A token with repo scope is required.

Fine-grained tokens

A token with the following repository permissions is required for read-only access:

Permission	Access
Contents	Read-only
Metadata	Read-only

License

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