A lightweight open-source Salesforce CI/CD template built on the GitHub Actions platform.
Перейти к файлу
Johnny Carmona 70eba129e4
Merge pull request #68 from github/dependabot/npm_and_yarn/npm_and_yarn-eac0ba9ef1
Bump axios from 1.7.2 to 1.7.5 in the npm_and_yarn group
2024-08-29 11:10:24 -04:00
.devcontainer Asymmetric Encryption Implementation w/ age (#53) 2023-04-06 14:28:14 -04:00
.github/workflows Merge pull request #62 from jorgectf/jorgectf/fix-actions-injection 2024-06-23 06:22:40 -07:00
.husky init sfdx project 2022-11-14 10:11:53 -05:00
.vscode init sfdx project 2022-11-14 10:11:53 -05:00
auth Update public-key.txt 2023-04-06 14:31:04 -04:00
config adding sfdx plugin configurability 2022-12-10 16:07:39 -05:00
docs Add setup docs and missing script (#56) 2023-04-18 17:33:28 -04:00
force-app/main/default init sfdx project 2022-11-14 10:11:53 -05:00
node-scripts resolved security finding by performing safety check on regexp from env var 2024-06-22 07:20:20 -07:00
release-notes Release notes folder and deployment timeout variable (#11) 2022-11-21 14:15:10 -05:00
scripts Updated commands to use sf instead of sfdx 2024-06-20 21:51:08 -07:00
.eslintignore init sfdx project 2022-11-14 10:11:53 -05:00
.eslintrc.json @actions/core installation, Release Branch Pull Request Handler workflow 2022-11-15 16:31:18 -05:00
.forceignore init sfdx project 2022-11-14 10:11:53 -05:00
.gitignore Add setup docs and missing script (#56) 2023-04-18 17:33:28 -04:00
.nvmrc cleaning up workflow files 2023-02-07 10:39:53 -05:00
.prettierignore init sfdx project 2022-11-14 10:11:53 -05:00
.prettierrc init sfdx project 2022-11-14 10:11:53 -05:00
CODEOWNERS Adding CODEOWNERS 2022-12-15 15:56:47 -08:00
CODE_OF_CONDUCT.md Merge branch 'main' of https://github.com/github/octoforce-actions into splitting-out-sfdx-deliverability 2023-01-31 09:58:06 -05:00
LICENSE Adding MIT License 2022-12-15 14:47:28 -08:00
README.md Add setup docs and missing script (#56) 2023-04-18 17:33:28 -04:00
SECURITY.md Merge branch 'main' of https://github.com/github/octoforce-actions into splitting-out-sfdx-deliverability 2023-01-31 09:58:06 -05:00
SUPPORT.md basic documentation 2023-01-27 11:31:36 -05:00
github-mark.png basic documentation 2023-01-27 11:31:36 -05:00
jest.config.js init sfdx project 2022-11-14 10:11:53 -05:00
package-lock.json Bump axios from 1.7.2 to 1.7.5 in the npm_and_yarn group 2024-08-29 15:08:49 +00:00
package.json updated dependencies to resolve security vulnerabilities. 2024-06-20 21:23:03 -07:00
sfdx-project.json SALESFORCE_FORMATTED_PROFILES_AND_PERMS repo var, auth folder & deploy-to-uat-sandbox job condition (#7) 2022-11-21 13:44:54 -05:00

README.md

octoforce-actions

A lightweight open-source template Salesforce CI/CD built on the GitHub actions platform.

Features

  • Automation to create a development sandbox and UAT sandbox for each issue created.
  • Automation to deploy metadata changes to UAT sandboxes for each pull request created against a release branch.
  • Automation to compile release notes when changes are merged into a release branch.
  • Automation to deploy changes to production.
  • Support for including desctructive changes in deployments.
  • Script to authenticate against sandboxes using SFDX and encrypt the credentials for use in GitHub Actions.
  • Setup script for MacOS to setup SFDX and NodeJS as well other development dependencies.
  • Basic Docker configuration for use in Codespaces.

Limitations

  • Setup script does not support Windows.
  • The number of dev sandboxes you are entitled to will determine how many issues your team can work on simultaneously.

Background

This project is meant to be a starting point for Salesforce developers who want to automate their CI/CD process using GitHub Actions. It is not meant to be a complete solution for all Salesforce development teams.

Requirements

NodeJS 14.x is the minimum requirement for this project. More recent versions of NodeJS are still being tested. We are currently testing Node 18.x and have found issues with authentication against sandboxes using SFDX web auth flow. The setup scripts require MacOS to run locally, however is not required to make use of this template. The sandbox authentication script requires SFDX to be installed and configured and requires a bash environment.

These actions rely on several repository secrets and variables to be set in the repository settings. Please refer to the Required Configurations section of our getting started doc for more details.

Your team will be required to follow the dev flow outlined here in order for the workflows in this repo to function as expected.

Getting Started

See the setup guide.

License

This project is licensed under the terms of the MIT open source license. Please refer to MIT for the full terms.

Maintainers

Owners

Support

This template will receive basic maintenace such as bug fixes and security updates.

GitHub Logo