3. Setting up sfops repository

Once you have forked the repository from sfops upstream (contact team for access) into a repository in your GitHub organisation, please set up the following variables and secrets.

Variables & Secrets

To use the associated workflows, you need to set the following repository secrets

VARIABLE	VARIABLE_TYPE	VALUE_TYPE	EXAMPLE	Comments
DOCKER_USERNAME	REPOSITORY_SECRET	STRING	username	The username of the account to push the built docker image into ghcr.io
DOCKER_SECRET	REPOSITORY_SECRET	STRING	token	PAT token that will allow the action to push the built packages to ghcr.io
SFP_REPO_URL	REPOSITORY_SECRET	STRING	https://<pat>@source.flxbl.io/flxbl/sfp-pro.git	If you have forked sfp-pro repository, please use the url of the repository.
GHA_TOKEN	REPOSITORY_SECRET	STRING	token	The token with read:org, write:repo and write:packages, workflow permission for the build action to update target repos

To test the workflow before provisioning to your actual GitHub action repository, you need to set up the following

VARIABLE	VARIABLE_TYPE	VALUE_TYPE	EXAMPLE	Comments
TEST_ORGS	REPOSITORY VARIABLE	STRING ARRAY	['flxbl']	Should be the name of the environment
REPO_OWNER	ENVIRONMENT_VARIABLE	STRING	<your_org_name>	Name of the github organisation
PROJECT_REPO	ENVIRONMENT_VARIABLE	STRING	sf-test-repo	These variables should be created within the environment variable named in TEST_ORGS The Project where this action would be invoked from
SFOPS_ACTION_REPO	ENVIRONMENT_VARIABLE	STRING	sfops-gh-actions-test	The repository that contains the actions
SFOPS_IMAGE	ENVIRONMENT_VARIABLE	STRING	ghcr.io/flxbl-io/<your_org>:development	The image to be used along with the tag
SFOPS_LITE_IMAGE	ENVIRONMENT_VARIABLE	STRING	ghcr.io/<your-org>/sfops-lite:development	The lite image to be used along with the tag

To deploy the workflow to the actual org, please setup the following

VARIABLE	VARIABLE_TYPE	VALUE_TYPE	EXAMPLE	Comments
ORGS	REPOSITORY VARIABLE	STRING ARRAY	['super-org']	Should be the name of the environment
REPO_OWNER	ENVIRONMENT_VARIABLE	STRING	<your_org_name>	Name of the github organisation
PROJECT_REPO	ENVIRONMENT_VARIABLE	STRING	sf-core	These variables should be created within the environment variable named in TEST_ORGS The Project where this action would be invoked from
SFOPS_ACTION_REPO	ENVIRONMENT_VARIABLE	STRING	sfops-gh-actions	The repository that contains the actions
SFOPS_IMAGE	ENVIRONMENT_VARIABLE	STRING	ghcr.io/<your_org>/sfops:latest	The image to be used along with the tag
SFOPS_LITE_IMAGE	ENVIRONMENT_VARIABLE	STRING	ghcr.io/<your_org>/sfops-lite:latest	The lite image to be used along with the tag

These variables will be automatically set up during the set up of sfops in your repository by the FLXBL team. This guide is only applicable when you are setting up a self managed instance of sfops