package
Publishes a file to a repository through the GitHub Contents API
npm install github-publishGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Publishes a file to a repository through the GitHub Contents API
npm install github-publishStable, but not feature complete
Currently missing support for deletes.
import { GitHubPublisher } from 'github-publish';
const publisher = new GitHubPublisher('token123', 'voxpelli', 'voxpelli.github.com');
const result = await publisher.publish('_post/2015-07-17-example-post.md', 'file content');
// If "result" is truthy then the post was successfully publishedusername of the owner of the repository to publish to and the name of the repository itself as repo.GitHubPublisher methodsPromise that resolves with either an object containing the content and sha of the existing file or with false if no such file exists in the repositorycontent as the filename to the repo of the publisher object. content should be either a string or a Buffer. Returns a Promise which resolves to the sha of the created object on success and to false on failure (failure is likely caused by a collision with a pre-existing file, as long as one haven't specified that it should be overridden).publish() optionsnew contentEstimated unpacked size across 3 packages.
2.1 MB
Includes dependencies.