feat: Move some Git commands behind a PlatformScm interface #19327

NiasSt90 · 2022-12-09T14:08:01Z

Changes

current state: six "util/git" functions are "moved" behind the PlatformSCM interface. more to follow...

Context

Closes #19065

Documentation (please check one with an [x])

I have updated the documentation, or
No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

Code inspection only, or
Newly added/modified unit tests, or
No unit tests but ran on a real repository, or
Both unit tests + ran on a real repository

…tebot#19065 current state: six "util/git" functions are "moved" behind the PlatformSCM interface. more to follow...

rarkins

Looks good to me, I would like to hear from @JamieMagee and @viceice about what they think of the lib/modules/platform/scm approach

HonkingGoose · 2022-12-09T21:12:38Z

Does merging this PR close this issue? Right now it's just referenced:

Move all Git commands behind a PlatformScm interface #19065

Or is this just one of the steps needed?

lib/modules/platform/scm.ts

needed for Gerrit platform impl.

NiasSt90 · 2022-12-15T15:13:22Z

With the current state of the PR, I have successfully migrated my Gerrit implementation (local) to the PlatformScm API.
This means this is the minimum necessary extension/adaptation for supporting Gerrit (but still not complete to support/implement non-git Scm-Platforms).

I need the new util/git functions (from 2387144) and with these i could write the GerritScm like:

const gerritScm: Partial<PlatformScm> = {
  isBranchModified,
  isBranchBehindBase,
  isBranchConflicted,
  branchExists,
  getBranchCommit,
  commitAndPush: commitFiles,
  deleteBranch: (branchName: string) => Promise.resolve(), //no-op for gerrit, there exists no remote-branches for PRs
};

The first six functions are all implemented in the Gerrit platform module and rely on results from the Gerrit REST-Api.

viceice

please extract the small git changes to separate PR's, they are unrelated to the scm interface and can then be merged faster.

lib/modules/platform/scm.ts

lib/util/git/index.ts

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

…entation still incomplete. I don't know how to migrate this completely (for existing configurations)?

I don't see a fully working option migration from of the (shared-config) variable platformCommit to a global PlatformScmId configuration. Therefore, i've added again the switch to the github scm module.

viceice

base classes will make future improvement more easy

lib/modules/platform/github/scm.ts

…lementation

lib/modules/platform/scm.ts

lib/modules/platform/default-scm.ts

lib/modules/platform/github/scm.ts

lib/modules/platform/scm.ts

moved all util/git mocks that are now behind the PlatformSCM to scm-mocks

# Conflicts: # lib/modules/manager/npm/post-update/index.ts # lib/workers/repository/process/extract-update.spec.ts # lib/workers/repository/process/extract-update.ts

lib/modules/platform/github/scm.spec.ts

lib/modules/platform/github/scm.ts

lib/modules/platform/scm.spec.ts

test/util.ts

test/setup.ts

lib/workers/repository/cache.ts

lib/workers/repository/config-migration/branch/create.spec.ts

viceice

only the import thing left

# Conflicts: # lib/modules/manager/npm/post-update/index.ts # lib/workers/repository/process/extract-update.spec.ts # lib/workers/repository/process/extract-update.ts # lib/workers/repository/process/index.spec.ts # lib/workers/repository/process/index.ts # lib/workers/repository/update/pr/index.spec.ts # lib/workers/repository/update/pr/index.ts

lib/workers/repository/onboarding/pr/index.spec.ts

test/setup.ts

viceice · 2023-02-21T09:49:06Z

@rarkins should we release as feature?

renovate-release · 2023-02-22T09:29:27Z

🎉 This PR is included in version 34.150.0 🎉

The release is available on:

GitHub release
34.150.0

Your semantic-release bot 📦🚀

refactor: Move all Git commands behind a PlatformScm interface renova…

366f919

…tebot#19065 current state: six "util/git" functions are "moved" behind the PlatformSCM interface. more to follow...

rarkins requested review from JamieMagee and viceice December 9, 2022 18:36

rarkins reviewed Dec 9, 2022

View reviewed changes

JamieMagee reviewed Dec 10, 2022

View reviewed changes

lib/modules/platform/scm.ts Outdated Show resolved Hide resolved

NiasSt90 added 2 commits December 13, 2022 15:11

move "commitAndPush" behind PlatformScm

28322fa

some small additional util/git functions

2387144

needed for Gerrit platform impl.

viceice reviewed Dec 29, 2022

View reviewed changes

NiasSt90 and others added 2 commits January 5, 2023 09:45

Update lib/modules/platform/scm.ts

bc67399

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

Update lib/modules/platform/scm.ts

eff5d81

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

This was referenced Jan 5, 2023

feat: Support for Platform "Gerrit" #18961

Merged

feat(git): allow commit-and-push to different target branch #19680

Merged

fix(git): checkout branch in a safer way #19681

Merged

merge main

56e8583

viceice mentioned this pull request Jan 9, 2023

feat(git): allow to install git-hook functions to local repositories #19685

Merged

6 tasks

NiasSt90 added 4 commits January 30, 2023 08:56

Merge remote-tracking branch 'origin/main' into PlatformSCM

8ee656e

remove wrongly added gerrit-stuff from this pr

966741a

migrate "platformCommit" configuration to PlatformScm 'github' implem…

ce7ced6

…entation still incomplete. I don't know how to migrate this completely (for existing configurations)?

add "platformCommit" config evaluation to github-scm module again

64c752c

I don't see a fully working option migration from of the (shared-config) variable platformCommit to a global PlatformScmId configuration. Therefore, i've added again the switch to the github scm module.

NiasSt90 requested a review from viceice February 3, 2023 14:54

viceice requested changes Feb 6, 2023

View reviewed changes

lib/modules/platform/github/scm.ts Outdated Show resolved Hide resolved

change from (partial)module-export to class based default-git-scm imp…

179cfa0

…lementation

NiasSt90 requested a review from viceice February 16, 2023 10:33

viceice requested changes Feb 16, 2023

View reviewed changes

NiasSt90 added 2 commits February 17, 2023 11:01

store scm-ctor and remove default scm instance

16d39c8

moved all util/git mocks that are now behind the PlatformSCM to scm-mocks

Merge remote-tracking branch 'origin/main' into PlatformSCM

7b5e696

NiasSt90 requested a review from viceice February 17, 2023 11:14

Merge remote-tracking branch 'origin/main' into PlatformSCM

afe9e4f

# Conflicts: # lib/modules/manager/npm/post-update/index.ts # lib/workers/repository/process/extract-update.spec.ts # lib/workers/repository/process/extract-update.ts

viceice reviewed Feb 20, 2023

View reviewed changes

review fixes

e2dfb0f

NiasSt90 requested a review from viceice February 20, 2023 12:12

viceice reviewed Feb 20, 2023

View reviewed changes

NiasSt90 added 2 commits February 21, 2023 07:47

fix: reordered the import ordering missed by "lint-fix"

77491bc

NiasSt90 marked this pull request as ready for review February 21, 2023 07:20

NiasSt90 requested a review from viceice February 21, 2023 07:20

viceice reviewed Feb 21, 2023

View reviewed changes

lib/workers/repository/onboarding/pr/index.spec.ts Outdated Show resolved Hide resolved

test/setup.ts Outdated Show resolved Hide resolved

more review fixes

588f521

NiasSt90 requested a review from viceice February 21, 2023 09:15

viceice approved these changes Feb 21, 2023

View reviewed changes

viceice changed the title ~~refactor: Move all Git commands behind a PlatformScm interface #19065~~ refactor: Move all Git commands behind a PlatformScm interface Feb 21, 2023

Merge branch 'main' into PlatformSCM

a5011e4

viceice requested review from rarkins, secustor and JamieMagee and removed request for rarkins February 21, 2023 12:29

Merge branch 'main' into PlatformSCM

e82064d

secustor approved these changes Feb 21, 2023

View reviewed changes

NiasSt90 added 2 commits February 21, 2023 15:45

Merge branch 'main' into PlatformSCM

e2033d1

Merge branch 'main' into PlatformSCM

7f4ea0e

viceice changed the title ~~refactor: Move all Git commands behind a PlatformScm interface~~ feat: Move some Git commands behind a PlatformScm interface Feb 22, 2023

viceice added this pull request to the merge queue Feb 22, 2023

Merged via the queue into renovatebot:main with commit dd6c8e5 Feb 22, 2023

github-actions bot locked as resolved and limited conversation to collaborators Mar 25, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Move some Git commands behind a PlatformScm interface #19327

feat: Move some Git commands behind a PlatformScm interface #19327

NiasSt90 commented Dec 9, 2022 •

edited

Loading

rarkins left a comment

HonkingGoose commented Dec 9, 2022

NiasSt90 commented Dec 15, 2022

viceice left a comment

viceice left a comment

viceice left a comment

viceice commented Feb 21, 2023

renovate-release commented Feb 22, 2023

feat: Move some Git commands behind a PlatformScm interface #19327

feat: Move some Git commands behind a PlatformScm interface #19327

Conversation

NiasSt90 commented Dec 9, 2022 • edited Loading

Changes

Context

Documentation (please check one with an [x])

How I've tested my work (please select one)

rarkins left a comment

Choose a reason for hiding this comment

HonkingGoose commented Dec 9, 2022

NiasSt90 commented Dec 15, 2022

viceice left a comment

Choose a reason for hiding this comment

viceice left a comment

Choose a reason for hiding this comment

viceice left a comment

Choose a reason for hiding this comment

viceice commented Feb 21, 2023

renovate-release commented Feb 22, 2023

NiasSt90 commented Dec 9, 2022 •

edited

Loading