Skip to content
Adam Ormsby edited this page Jul 25, 2021 · 6 revisions

Features

New in v3

Important: Some input variable names were changed for v3 to improve clarity. Please see the input change table for reference.

Implementation of some features may have changed between v2/v3, but the action includes all features from v2. Additionally, v3 brings the following functionality --

Test Mode

Setting the input var test_mode: true enables a set of input tests designed to help with your action setup. The tests will run instead of the action, and they will verify the following things:

  • Does the target_sync_branch exist in the target repo?
  • Does the upstream_sync_repo exist?
  • Does the upstream_sync_branch exist in the upstream repo?
  • Are you authorized to access the upstream repo?
    • If private, does upstream_repo_access_token provide access?
  • Are git user/email/pull configuration successful? And do they correctly reset?

If you have any failed tests, your action input values are likely incorrect or something is missing in your setup. Running test mode before deployment can help avoid several issues. See setup notes for help configuring the action.

Suggestions for more tests are welcome! Please open an issue to share your ideas.

v2.4

  • Keep a single branch up to date with the latest commits from a branch on a remote repo
  • Include a token to sync commits from a private upstream repo (HTTPS auth only)
  • Custom configuration for git command options throughout the process - checkout, pull, push, log, etc.
  • Custom settings options for git config - user, email, and pull settings - used during the action and reset when the step is complete

After v2.4, no further work will be done for v2. All future updates will be for v3 and higher.

Possible Upcoming Features

  • SSH Auth: The action currently uses HTTPS auth. It would be a bit of work to figure out adding SSH, but if there's a need for it then I'm open to it. Discuss in issue #17.
  • Local Mode: It could be handy to run this action locally on your machine. It's probably close to functional. already, but I'm unsure what special considerations must be made. Discuss in issue #30.
Clone this wiki locally