Skip to content

zdocs Prod Install

jhilyard edited this page Feb 11, 2021 · 1 revision

Installing or Upgrading Summit Events App in Production, Sandbox or Dev Orgs

Note: We are working to create a managed package for this.

Note: Summit Events is currently code that is not packaged, so installation needs to be done by a developer using the steps below. There are two ways this install can be done (SFDX or Cumulus CI), choose the one that is easist for you.

Method 1 - SFDX

Your first job is to make sure that you have the following installed on the computer you are using to install Summit Events to Salesforce:

  1. Python 3+
  2. Git
  3. Salesforce Command Line Interface (CLI)

Note that Cumulus CI is not needed to for this method

Connect an org

Connect your command line to the org you want to install Summit Events in. Use the following command to initiate this authentication:

sfdx force:auth:web:login --setdefaultusername --setalias my-hub-org

"my-hub-org" above is an alias. You can choose whatever alias you wish as it is used to identify this particular dev hub if you have multiple

Gitting the code (Get it?)

  1. Log in to GitHub.

  2. Go to the Summit Events repository.

  3. Fork a copy of the repository to your own account by clicking the "Fork" button at the top of the GitHub page. This will copy all the code from the repository into your personal account. Code in your own repository will not affect the main repository in any way.

  4. Navigate to your forked copy of the repository. The path at the top of the page should include your GitHub username in it.

  5. Click on the "Clone or download" green drop-down near the top left of the page. Copy the URL to clone your forked repository.

  6. On your computer navigate to the folder that you wish to put your cloned code in. Remember that cloning will create a directory for the code for you. You may also wish to use GitHub desktop to make this whole process prettier and less intimidating. This documentation will outline command line usage of git, but both are acceptable.

  7. Get a copy of the Event App code from GIT. If you are not directly collaborating with the project you may want to fork the project into your own GIT repository:

    git clone <the URL you copied from your forked repository>
    

Installing the Summit Events app through the Salesforce Command Line Interface

You will need to use the Salesforce CLI (Command Line Interface) for this next part. If you prefer, you can do it through Visual Studio Code instead

  1. On your computer, navigate to the installation folder in Command Prompt

  2. Use Salesforce CLI to push the code into Salesforce

    sfdx force:source:deploy --json --loglevel fatal -l RunLocalTests
    
  3. Verify that the installation is successful by logging into your org and going to Setup --> Deployment Status, then seeing if the deployment is marked as Succeeded.

Note: Since Summit Events is deployed in the same manner as a change set, it will not display as an installed package.

Your org is ready!

Your installation of Summit Events in your org is completed and ready for your admin to begin setup!

Method 2 - Cumulus CI

Connect the org you want to deploy to:

cci org connect <org_name>

Example staging:

cci org connect staging

Example production:

cci org connect production

Gitting the code (Get it?)

  1. Log in to GitHub.

  2. Go to the Summit Events repository.

  3. Fork a copy of the repository to your own account by clicking the "Fork" button at the top of the GitHub page. This will copy all the code from the repository into your personal account. Code in your own repository will not affect the main repository in any way.

  4. Navigate to your forked copy of the repository. The path at the top of the page should include your GitHub username in it.

  5. Click on the "Clone or download" green drop-down near the top left of the page. Copy the URL to clone your forked repository.

  6. On your computer navigate to the folder that you wish to put your cloned code in. Remember that cloning will create a directory for the code for you. You may also wish to use GitHub desktop to make this whole process prettier and less intimidating. This documentation will outline command line usage of git, but both are acceptable.

  7. Get a copy of the Event App code from GIT. If you are not directly collaborating with the project you may want to fork the project into your own GIT repository:

    git clone <the URL you copied from your forked repository>
    

Deploy code straight to a defined org

First rebuild the root src so it reflects any changes made. Note: The src directory should have been rebuilt if you have deployed to a scratch org like you should have.

cci task run dx_convert_from

Now deploy the src directory to the org of your choice.

cci task run deploy --org <org_nickname>

Your org is ready!

Your installation of Summit Events in your org is completed and ready for your admin to begin setup!

Clone this wiki locally