Create CommitToGit Command by rain-on · Pull Request #1912 · OctopusDeploy/Calamari

rain-on · 2026-05-05T06:45:21Z

The commitToGit step is basically the script step, but is also able to copy some of the steps packages into the target git repository.

Thus, there is a single variable which contains a json blob defining which packages should be used for copying (and thus should only be substituted with non-sensitive variables).

The step executes the following in order:
Phase 1:

Clone target repository into known location, and create variable containing its working directory

Phase 2:

Unpack primary package, and all associated packages
Unpack all git dependencies
Substitute all variables into the script if it is inline.

Phase 3:

Substitute all variables into packages which are not listed in the "input file metadata"

Phase 4:

Substitute non-sensitive values into all packages and git-deps in the "input file metadata"
Copy the specified files into the repository created in Phase 1

Phase 5:

Execute the script provided (run from deployment directory, but can access respository via variable)

Phase 6:

Commit changes to repo
Push to remote and create a PR if required (as per Argo step)
Raise output variables.

⚠️ Does this change require a corresponding Server Change?
⚠️ If so - please add a "Requires Server Change" label to this PR!

…teParser Also fix dangling references in TransformAndCommitToGitCommand left by the removed files: drop the stale CommitWorkspaceToGitRepositoryConvention AddRange block and correct pathToPackage -> packageFile so the build is clean. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…Connection Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…commit_to_git

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…ntions Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

This file has been superseded by inline delegates and is no longer needed. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…mand Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Jtango18 · 2026-05-07T23:45:14Z

+                public const string Url = "Octopus.Action.Git.TargetRepositoryUrl";
+                public const string Username = "Octopus.Action.Git.TargetRepositoryUsername";
+                public const string Password = "Octopus.Action.Git.TargetRepositoryPassword";
+                public const string Reference = "Octopus.Action.Git.TargetRepositoryBranch";
+                public const string DestinationPath = "Octopus.Action.Git.DestinationPath";


The mix between target and destination confuzzled me...might be just my brain tho.

yeah, we'' consolidate on the TargetRepository naming convention

Jtango18 · 2026-05-07T23:53:34Z

+            var dependencyNames = new List<string>();
+            // we reverse the order of the array so that we maintain the order that sources at the top take higher precendences (i.e. are adding to the --values list later),
+            // however, within a source, the file path order must be maintained (for consistency) so that later file paths take higher precendence 
+            foreach (var jToken in parsedJsonArray.Select((json, index) => json))


Where is the reversal mentioned in the comment? Am I missing something?

yup - stolen from another step - this is not true in this context - removed.

Jtango18 · 2026-05-07T23:57:30Z

+        this.configFactory = configFactory;
+    }
+
+    public override int Execute(string[] commandLineArguments)


💭 This feels like a massive method. Seems like there are 4 pieces perhaps

The file copy

the transformation

the commit and

The script substitution.

Are they worth separating out?

yup - broke this up into separate functiuons to represent each phase

Jtango18 · 2026-05-07T23:57:53Z

+        var deployment = new RunningDeployment(pathToPackage, variables);
+        var baseWorkingDirectory = deployment.CurrentDirectory;
+        var repositoryConfig = configFactory.CreateRepositoryConfig(deployment);
+        var repositoryFactory = new RepositoryFactory(log, fileSystem, baseWorkingDirectory, gitVendorPullRequestClientResolver, clock);


Can this be injected?

don't think so - as we don't know the baseWorking directory until after the deployment is created

Jtango18 · 2026-05-07T23:58:38Z

+                                              var commitParams = repositoryConfig!.CommitParameters;
+                                              var updater = new RepositoryUpdater(commitParams, log, new UserDefinedCommitMessageGenerator(commitParams.Description));
+
+                                              //TODO(tmm): This is a smell, shouldn't need the FileUpdateResult here :/


Does this need to be To-Done?

I've cleaned it up - its not great, but its better.

Jtango18 · 2026-05-07T23:59:40Z

+        var extractAllPackages = new List<IConvention>
+        {
+            //we only want to include files which are NOT explicitly referenced as dependencies (i.e. we have files which are to be copied into the repo (referenced in variable), and some which should just be used for script dependencies. 
+            new StageDependenciesConvention(pathToPackage, fileSystem, new CombinedPackageExtractor(log, fileSystem, variables, commandLineRunner), new PackageVariablesFactory()),


PackageVariablesFactory() is created here and again below. Is that necessary?

Its super light - and now that this broken out to function-per-phase, it make the dependency less simple

Jtango18

Mostly questions from me, but nothing too dire blocking here.

rain-on and others added 30 commits March 27, 2026 16:34

first draft of convention and command

b14fef5

refactor: AuthenticatingRepositoryFactory implements IRepositoryFactory

ca161e4

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

refactor: RepositoryAdapter takes IRepositoryFactory and accepts IGit…

86c0523

…Connection Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Merge remote-tracking branch 'origin/main' into tmm/refactor_repo

c142262

not great

694a16f

Merge remote-tracking branch 'origin/main' into tmm/refactor_repo

fe54f88

make the RepositoryAdapter more generic for use in new steps

9d3e504

Rename SourceUpdateResult to RepositoryUpdates

7e5cef5

minor steps forwards

a65fa2a

add in a basic variable parser

5a9ed85

maybe this is getting out of hand

996a052

Trying to make it look professional

b70ed37

all written some empty bits

c22c55f

clean up

261d4fd

force basic auth header

564caab

cleaning up bits already fixed

f3ebf32

Merge commit '564caab2d0a1f424b6ca409235091f5f5f43b0c1' into tmm/new_…

b99f872

…commit_to_git

trying to create tests for command

03d9ecb

ok sorted out how to do the tests, now for claude

4a2e3ed

Getting there

e28bcab

Merge remote-tracking branch 'origin/main' into tmm/new_commit_to_git

af9e330

remove unused changes

f6aa2bf

docs: add design spec for CommitToGitCommand repository conventions

239cf7e

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

docs: add implementation plan for CommitToGitCommand repository conve…

afae051

…ntions Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

chore: remove stale GitRepositoryConvention skeleton

4b60f7a

This file has been superseded by inline delegates and is no longer needed. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

feat: add StageAllChanges to RepositoryWrapper

07b7a49

feat: implement clone, copy, and commit conventions in CommitToGitCom…

7922c45

…mand Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Getting there slowly

28fec92

Merge remote-tracking branch 'origin/main' into tmm/new_commit_to_git

f247ca0

rain-on added 10 commits April 27, 2026 11:16

tidy up test

5b89ce8

Merge remote-tracking branch 'origin/main' into tmm/new_commit_to_git

7efde4f

minor cleanup

af8f4fc

Merge remote-tracking branch 'origin/main' into tmm/new_commit_to_git

b42216a

slowly tidying up

d33d53b

do not unpack the script multiple times

8cf300d

Merge remote-tracking branch 'origin/main' into tmm/new_commit_to_git

715bb91

copy into subfolder

f572706

after claude review

3996b8e

added in output variables

81086ea

rain-on requested review from flin-8 and zentron May 5, 2026 06:45

rain-on added 7 commits May 5, 2026 16:46

remove extraction checkers

c8064bf

remove explicitlyreferenceddependencies

9214fd5

get git stuff out of argo files

fb6556f

and we have our own factory

71808f4

about as ready as ever

adf6add

post first round cleanup

ca9f28c

final review - removed log from metadataparser

4c2031e

Jtango18 reviewed May 7, 2026

View reviewed changes

Jtango18 approved these changes May 8, 2026

View reviewed changes

rain-on added 2 commits May 8, 2026 11:09

fixed basic review comments

16ef3aa

post review

4f4b1a3

rain-on merged commit 6c820fd into main May 8, 2026
33 checks passed

rain-on deleted the tmm/new_commit_to_git branch May 8, 2026 03:57

Conversation

rain-on commented May 5, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jtango18 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants