1. Create repositories
Last updated
Last updated
In order to set up sfops in your GitHub organization, you need to set up the following repositories:
These repositories are essential for a functioning sfops setup:
sfops
Repository that contains the source code for sfops
sfops-gh-actions
The 'production' repository that will contain the workflows and actions that is built from the sfops directory
Your Salesforce projects will be consuming the actions and reusable workflows from this repository
sfops-dev-central
The 'production' dev central repository that will be used to build the GitHub pages static website which will house the sfops dev central
<project-repo>
The mono repository that will contain your Salesforce config/code
These repositories are only needed for specific scenarios:
sfp-pro
Repository that contains the source code for sfp pro, which has additional features that are required for sfops
Only if you intend to maintain your own fork of sfp-pro
sfops-gh-actions-test
The 'test' repository that will contain the workflows and actions that is built from the sfops directory
Required if you want to make changes to the default actions and workflow and test it before rolling out to the production 'sfops-gh-actions' repository
sfops-dev-central-test
The 'test' dev central repository that will be used to build the GitHub pages static website which will house the sfops dev central
Required if you want to make changes to the default actions and workflow and test it before rolling out to the production 'sfops-dev-central' repository
<project-test-repo>
The mono 'test' repository that will contain your Salesforce config/code
Required if you want to test the workflows/actions before rolling out to project repository
Critical Step: After creating the repositories, you MUST configure the sfops-gh-actions repository to allow other repositories to use its reusable workflows. Without this, your project repositories will fail with "workflow was not found" errors.
Navigate to your sfops-gh-actions repository
Go to Settings → Actions → General
In the "Workflow permissions" section:
Select "Read and write permissions"
This allows workflows to have read and write permissions in the repository for all scopes
Required for workflows to create tags, push changes, and publish artifacts
Scroll down to the "Access" section at the bottom
Select one of these options based on your security requirements:
Accessible from repositories in the '[your-org]' organization (Recommended)
Allows any repository in your organization to use the workflows
Access is allowed only from private or internal repositories
Accessible from repositories in the '[your-enterprise]' enterprise
If you're using GitHub Enterprise and want broader access
Click Save to apply all settings
If you created a test repository, repeat the same steps:
Navigate to your sfops-gh-actions-test repository
Go to Settings → Actions → General
In the "Access" section, select the same option as above
Click Save
The sfops-dev-central repository hosts the dashboard as a GitHub Pages site. You must enable Pages after creating the repository:
Navigate to your sfops-dev-central repository
Go to Settings → Pages (or directly: https://github.com/YOUR_ORG/sfops-dev-central/settings/pages)
Under "Build and deployment" → "Source", select:
GitHub Actions (this is required for the dashboard workflows to deploy)
Click Save
Important: GitHub Pages must be enabled BEFORE running any dashboard update workflows. If not enabled, workflows will fail with "Get Pages site failed" errors.
If you created a test dev-central repository, repeat the same steps:
Navigate to your sfops-dev-central-test repository
Go to Settings → Pages
Under "Source", select GitHub Actions
Click Save