Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 2.7 KB

README.md

File metadata and controls

51 lines (32 loc) · 2.7 KB
Raw

Simplifier Project Source Control

A simple repo that can be forked and configured to download, unpack, commit, create a PR and merge the current state of a Simplifier project.

Prequsites

A valid Simplifier account.

Enable actions

The action is disabled in this repo, so must be enabled. Additionally, when forking a repo, even if an action is enabled in the original repo, it may be necessary to enable actions to run as they are by default set to disabled on fork. See the github docs on forking settings in regards to actions, and enabling/disabling workflows for more details.

Schedule to run

The action is set to run hourly by default in the action file.

Further info on using a scheduled cron job in an action.

Respository secrets required

Docs on creating secrets for a respository.

Secrets to add:

  • REPO_TOKEN
    • A GitHub token that has privileges to create branches, commit to branches, use workflows and create PR's.
    • See GitHub docs on using PAT tokens
  • COMITTER
    • User to commit as.
  • SIMPLIFIER_USER
    • Simplifier user that has access to project.
  • SIMPLIFIER_PWD
    • Password for Simplifier user.

Respository variables required

Docs on creating variables for a respository.

Variables to add:

  • COMITTER_NAME
    • Name of user to commit as.
  • SIMPLIFIER_ADDRESS
    • Address of project - e.g. https://api.simplifier.net/<project>/zip
    • See Firely docs on project zip using the Simplifier API

Configure branches to delete automatically

The action will create and merge a PR into main. To automatically delete the head branch when the PR is merged, see GitHub docs

Updated at: Tue Jun 13 08:12:44 UTC 2023