diff --git a/.github/workflows/env-create.yml b/.github/workflows/env-create.yml index 7e834fb..eee2a0a 100644 --- a/.github/workflows/env-create.yml +++ b/.github/workflows/env-create.yml @@ -25,7 +25,7 @@ on: The metadata in your sandbox will be kept in sync with the metadata in this branch. - OrgFlow will create the branch from the head of `main` (if not already created). Make sure that the branch you provide is not already being used by another environment. + OrgFlow will create the branch from the head of `production` (if not already created). Make sure that the branch you provide is not already being used by another environment. required: true # The env:create command needs to be able to push changes back to the repo. diff --git a/.github/workflows/env-flowout.yml b/.github/workflows/env-flowout.yml index a0214cc..76d8bc3 100644 --- a/.github/workflows/env-flowout.yml +++ b/.github/workflows/env-flowout.yml @@ -3,7 +3,7 @@ name: Flow out an environment on: push: - branches-ignore: [ main ] # Remove this line to enable deployments to production. Note- we assume that the production environment is backed by a branch called `main`; if this is not the case, then you'll need to update this value. + branches-ignore: [ production ] # Remove this line to enable deployments to production. Note- we assume that the production environment is backed by a branch called `production`; if this is not the case, then you'll need to update this value. jobs: flow-out: diff --git a/.github/workflows/stack-create.yml b/.github/workflows/stack-create.yml index c22e043..072dc82 100644 --- a/.github/workflows/stack-create.yml +++ b/.github/workflows/stack-create.yml @@ -58,7 +58,7 @@ jobs: # Run OrgFlow command: - name: stack:create run: | - orgflow stack:create -n="${{ secrets.ORGFLOW_STACKNAME }}" -r="$GITHUB_SERVER_URL/${{ github.repository }}.git" -b=main -u="${{ secrets.SALESFORCE_USERNAME }}" -p="${{ secrets.SALESFORCE_PASSWORD }}" -i=UseExisting -e=Production + orgflow stack:create -n="${{ secrets.ORGFLOW_STACKNAME }}" -r="$GITHUB_SERVER_URL/${{ github.repository }}.git" -b=production -u="${{ secrets.SALESFORCE_USERNAME }}" -p="${{ secrets.SALESFORCE_PASSWORD }}" -e=Production # Publish diagnostic bundles to artifacts (if any): - name: Publish diagnostic bundle as artifact diff --git a/README.md b/README.md index 01e7e2f..6a748c5 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,6 @@ This repository contains a few sample workflows to quickly get you up and runnin ## First things first This is a template repository, and you'll need to create a new repository (using this repository as a template) to be able to follow this guide. -![image](https://user-images.githubusercontent.com/2872984/133998220-1a4e6ec7-2400-43f1-9acd-4782a5ee219a.png) - Click the big, green, `Use this template` button near the top of this page, and follow the instructions. **Make sure that you create a private repository** because we'll be committing your Salesforce metadata to it. ## Getting started @@ -36,12 +34,14 @@ A stack is a link between Salesforce and a Git repository. Go to the `Actions` tab in this repo, and run the workflow called `Create the stack`. +When OrgFlow creates your stack, it will also create your first environment (called `Production`). This environment is connected to the production Salesforce org that you provided the username and password for. You will see that a git branch called 'production' has been created too, and that the metadata from your salesforce org has been committed to this branch. + ### 3. Add another environment Environments are a link between a specific Salesforce org and a branch within the Git repository. You already created an environment for your production org when you created the stack, but now we are going to create an environment for a sandbox org. Go to the `Actions` tab in this repo, and run the workflow called `Create an environment`. -Pick a unique name for this environment (your stack only contains a single environment at the moment, and it is called `Production`, so just pick anything other than `Production`). We recommend simply `A`. +Pick a unique name for this environment (your stack only contains a single environment at the moment, and it is called `Production`, so just pick anything other than `Production`). For the purposes of this demo, we recommend simply `A`. Provide sandbox and Git branch names (we recommend `OrgFlowA` and `sb/orgflowa` respectively).