github

github

The github option allows you associate your specification with a repository on GitHub.

It takes either a string (URL to your repo or a string of format: org/repo) or an object with the following properties:

• repoURL - the URL for the repository (e.g., https://github.com/w3c/browser-payment-api)
• branch - optional, the branch you are using for GitHub pages. It defaults to "gh-pages".
• pullsURL - optional, a filtered pull requests URL (useful for monorepo scenarios where multiple specs are served from the same repository)
• commitHistoryURL - optional, a filtered url with commits to the files/directories where a given specification is created (useful for monorepo scenarios where multiple specs are served from the same repository)

This automatically generates:

• githubAPI
• issueBase
• edDraftURI

It adds "Feedback:" to the header of the document, with the appropriate links to your GitHub repository.

This is normally what you want:

var respecConfig = {
  github: "w3c/browser-payment-api",
};

var respecConfig = {
  github: "https://github.com/w3c/browser-payment-api",
};

This example shows a repository whose specs are being served from a "public-docs" branch.

var respecConfig = {
  github: {
    repoURL: "https://github.com/w3c/browser-payment-api",
    branch: "public-docs", // alternative branch
  },
};

This example shows a monorepo scenario where issues are collected on a child repository but specs are all generated on a single repository.

var respecConfig = {
  github: {
    repoURL: "https://github.com/w3c/core-aam",
    pullsURL: "https://www.github.com/w3c/aria/pulls?q=is%3Apr+is%3Aopen+core-aam",
    commitHistoryURL: "https://www.github.com/w3c/aria/commits/main/core-aam/",
  },
}