github/octoforce-actions
Watch
1
0
Fork
You've already forked octoforce-actions
 0
mirror of https://github.com/github/octoforce-actions synced 2026-07-22 21:03:50 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
369 commits 24 branches 1 tag 5.5 MiB
  • Shell 45.5%
  • Python 26.7%
  • Dockerfile 15.6%
  • JavaScript 12.2%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Rob Dietrick 6fb5d47ce3
 Merge pull request #83 from rdietrick/main 
Add dry-run deployment support
2026-04-28 11:23:29 -07:00
.devcontainer Merge remote-tracking branch 'origin/main' into dev 2025-03-19 14:03:31 -07:00
.github Merge branch 'main' into rm-metadata 2026-04-27 16:35:02 -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 auth/public-key.txt 2026-04-24 13:28:22 -07:00
config adding sfdx plugin configurability 2022-12-10 16:07:39 -05:00
docs Add PR_VALIDATION_DEPLOY_DISABLED environment variable 2026-04-23 21:38:45 -07:00
node-scripts modified branch filter to work with newer version of @actions/core 2026-03-29 20:36:25 -07:00
release-notes remove build artifacts 2026-04-23 22:02:07 -07:00
scripts Update echo message for encrypted login URL file 2026-04-27 16:23:11 -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 upgrade node version 2026-03-30 07:57:43 -07: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
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
CODEOWNERS Update CODEOWNERS file with new maintainers 2026-04-26 06:56:49 -07:00
github-mark.png basic documentation 2023-01-27 11:31:36 -05:00
jest.config.js remove nvm install and redundant node module installations 2022-12-28 17:45:29 +00:00
LICENSE Adding MIT License 2022-12-15 14:47:28 -08:00
package-lock.json removed metadata updated npm deps 2026-04-23 21:57:05 -07:00
package.json modified branch filter to work with newer version of @actions/core 2026-03-29 20:36:25 -07: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
sfdx-project.json Update sourceApiVersion from 55.0 to 66.0 2026-04-27 16:24:02 -07:00
SUPPORT.md basic documentation 2023-01-27 11:31:36 -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