メインコンテンツまでスキップ

GitHub Connectors

GitHub Connectors link a GitHub repository to Docwize, syncing files from selected branches into Docwize folder structures. Each connector maps one repository; multiple connectors can be configured across different repositories or GitHub accounts.

Who configures this

Users with the Manage Connectors permission, accessible from New > Third Party Connectors > GitHub Connectors.

GitHub Connectors panel

GitHub Connectors panel

GitHub Connectors panel

ControlDescription
SearchFilters the list of configured repositories by name.
+ Add RepositoryOpens the Add Repository dialog to configure a new repository connector.
+ Add First RepositoryAppears in the empty state. Opens the same Add Repository dialog.

Add Repository

Selecting + Add Repository or + Add First Repository opens the Add Repository dialog.

Connect GitHub Account

Add Repository dialog

Add Repository dialog

ElementDescription
GitHub account dropdownAppears when at least one GitHub account has already been connected to the organisation. Select an existing account to use that connection for this repository.
Connect a different accountAppears alongside the dropdown when an existing account is selected. Use this to authenticate a new GitHub account instead.
Connect GitHub buttonAppears when no existing account is available. Installs the Docwize GitHub App on a GitHub account. Access can be granted to all repositories or to selected repositories only during the GitHub authorisation step.

Branch → Folder Mappings

Maps GitHub branches to Docwize folder destinations. This section is inactive until the repository is saved for the first time.

Once saved, use Discover Branches to auto-create the folder structure based on the repository's branch list.

Advanced Settings

Add Repository — Advanced Settings

Add Repository — Advanced Settings

Import Filters

FieldDescription
File Extensions (comma-separated)Restricts sync to files with the specified extensions. Leave blank to sync all file types.
Path Prefixes (comma-separated)Restricts sync to files under the specified path prefixes within the repository. Leave blank to sync from the repository root.

Default Doc Number Prefix

FieldDescription
Default Doc Number PrefixThe prefix applied to document numbers generated for files synced from this repository. Defaults to GH.

Scheduled Auto-Pull

FieldDescription
ScheduleSets how frequently Docwize automatically pulls updates from GitHub. Defaults to No schedule (manual only), which requires a manual sync trigger.

Troubleshooting

IssueDetail
Branch → Folder Mappings is inactiveSave the repository connector first. The section becomes active after the first save, at which point Discover Branches can be used.
Repository not visible after connectingConfirm the Docwize GitHub App was granted access to the repository during the GitHub authorisation step. Repository access can be updated in GitHub App settings at any time.
  • Permissions — the Manage Connectors permission controls access to this area