octoforce-actions

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

Перейти к файлу

Arun 802709c076 ci: Use GITHUB_OUTPUT envvar instead of set-output command		2024-01-12 21:36:00 -08:00
.devcontainer	Asymmetric Encryption Implementation w/ age (#53 )	2023-04-06 14:28:14 -04:00
.github/workflows	ci: Use GITHUB_OUTPUT envvar instead of set-output command	2024-01-12 21:36:00 -08:00
.husky	…
.vscode	…
auth	Update public-key.txt	2023-04-06 14:31:04 -04:00
config	…
docs	Add setup docs and missing script (#56 )	2023-04-18 17:33:28 -04:00
force-app/main/default	…
node-scripts	…
release-notes	…
scripts	Add setup docs and missing script (#56 )	2023-04-18 17:33:28 -04:00
.eslintignore	…
.eslintrc.json	…
.forceignore	…
.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	…
.prettierrc	…
CODEOWNERS	…
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	…
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	…
package-lock.json	…
package.json	…
sfdx-project.json	…

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.