diff --git a/README.md b/README.md index 11b992d..d2959d5 100644 --- a/README.md +++ b/README.md @@ -35,13 +35,14 @@ plugins: [ resolve: `@adobe/gatsby-source-github-file-contributors`, options: { pages: { - paths: ['src/pages'], - extensions: ['md'] + root: '', // root of the page paths (below) in the Github repo + paths: ['src/pages'], // relative path of the pages from the config + extensions: ['md'] // page extensions to filter for }, repo: { - token: process.env.GITHUB_TOKEN, - owner: process.env.GITHUB_REPO_OWNER, - name: process.env.GITHUB_REPO_NAME, + token: process.env.GITHUB_TOKEN, // Github Personal Access Token + owner: process.env.GITHUB_REPO_OWNER, // user or org name + name: process.env.GITHUB_REPO_NAME, branch: process.env.GITHUB_REPO_BRANCH } } diff --git a/test/gatsby-node.test.js b/test/gatsby-node.test.js index 487f9d1..20eadb5 100644 --- a/test/gatsby-node.test.js +++ b/test/gatsby-node.test.js @@ -70,6 +70,12 @@ test('sourceNodes', async () => { expect(gatsbyHelpers.actions.createNode).toHaveBeenCalledTimes(pages.length) expect(mockGithubFetchContributors).toHaveBeenCalledTimes(pages.length) + options.root = 'my-root' // coverage + mockGlobby.mockResolvedValueOnce([]) + await expect(gatsbyNode.sourceNodes(gatsbyHelpers, options)).resolves.toEqual(undefined) + expect(gatsbyHelpers.actions.createNode).toHaveBeenCalledTimes(pages.length) + expect(mockGithubFetchContributors).toHaveBeenCalledTimes(pages.length) + pages.forEach((page, index) => { const { owner, name, branch, token } = options.repo expect(mockGithubFetchContributors).toHaveBeenNthCalledWith(index + 1, owner, name, branch, page, token)