The gh-pages
branch is automatically created and updated by the reports.yml
workflow. If the branch does not exist yet, run the workflow manually once or wait for the first push to main
.
Repository Setup
To fully utilize the automation and documentation features provided by FastForward DevTools, consumer repositories require specific configurations in GitHub.
GitHub Pages
FastForward DevTools automatically generates and deploys reports, test coverage, and API documentation to GitHub Pages.
- Navigate to your repository on GitHub.
- Go to Settings > Pages .
- Under Build and deployment
> Branch
:
Select the ``gh-pages`` branch.
Select
/ (root)as the folder. * Click Save .
GitHub Wiki
The wiki synchronization feature allows you to maintain documentation in Markdown within your repository and have it automatically published to the GitHub Wiki.
Initial Manual Step Required
GitHub does not create the underlying wiki repository until at least one page is created via the web interface. You MUST
create an initial Home.md
page manually before using dev-tools wiki --init
or any automated sync features.
- Navigate to your repository on GitHub.
- Click the Wiki tab.
- Click Create the first page (or New Page ).
- Ensure the title is
Homeand add some initial content. - Click Save Page .
Once this is done, the wiki can be cloned as a submodule and synchronized by the DevTools commands.
Workflow Permissions
GitHub Actions must have permission to push changes to your repository and, for the changelog release flow, to open release-preparation pull requests.
- Go to Settings > Actions > General .
- Scroll down to Workflow permissions .
- Select Read and write permissions .
- Enable Allow GitHub Actions to create and approve pull requests .
- Click Save .
Without these permissions, the wiki.yml
and reports.yml
workflows will fail when attempting to deploy content, and the changelog.yml
workflow will fail when trying to open a release/v...
pull request.
If the permission controls are disabled or grayed out, the repository is usually constrained by organization policy or by missing admin access. This is separate from branch protection. Branch protection affects whether the generated release pull request can be merged, while workflow permissions affect whether GitHub Actions can create that pull request at all.