Support shallow clone in GitSCMSource

[long76]

in current state CloneOptionTrait ignored, this PR allow set depth when you need find branch

Testing done

cheked locally in pipeline with

resolveScm([
        ignoreErrors: false,
        source      : gitSource(
                credentialsId: 'git-cred',
                remote: 'https://....',
                traits: [cloneOption(cloneOption(depth: 1, shallow: true)), gitBranchDiscovery()]
        ),
        targets     : ['main', 'master']
])

17:55:17  Checking for first existing branch from [main, master]...
17:55:17   > git rev-parse --resolve-git-dir /var/jenkins_home/caches/git-xxx/.git # timeout=10
17:55:17  Setting origin to https://site/xxx.git
17:55:17   > git config remote.origin.url https://site/xxx.git # timeout=10
17:55:17  Fetching & pruning origin...
17:55:17  Listing remote references...
17:55:17   > git config --get remote.origin.url # timeout=10
17:55:17   > git --version # timeout=10
17:55:17   > git --version # 'git version 2.52.0'
17:55:17  using GIT_HTTP to set credentials
17:55:17   > git ls-remote -h -- https://site/xxx.git # timeout=10
17:55:17  Fetching upstream changes from origin
17:55:17   > git config --get remote.origin.url # timeout=10
17:55:17  using GIT_HTTP to set credentials
17:55:17   > git fetch --no-tags --force --progress --prune --depth=1 -- origin +refs/heads/*:refs/remotes/origin/* # timeout=10
17:55:18  Checking branches...
17:55:18    Checking branch main
17:55:18      Met criteria
17:55:18  Processed 1 branches
17:55:18  Found main at revision xxxx

Submitter checklist

• Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
• Ensure that the pull request title represents the desired changelog entry
• Please describe what you did
• Link to relevant issues in GitHub or Jira
• Link to relevant pull requests, esp. upstream and downstream changes
• Ensure you have provided tests that demonstrate the feature works or the issue is fixed

[MarkEWaite]

Thanks! Needs automated tests that confirm the feature works as expected. Needs documentation that describes it so that users have an example they can use.

[long76]

Needs documentation that describes it so that users have an example they can use.

Pipeline syntax generate code resolveScm with cloneOption trait. Without these chnages trait will be ignored.

[MarkEWaite]

Needs documentation that describes it so that users have an example they can use.

Pipeline syntax generate code resolveScm with cloneOption trait. Without these chnages trait will be ignored.

That is certainly necessary, but I also like to include documentation in the README. People do not always use the syntax generator.

[long76]

Seems it's enough)

[MarkEWaite]

Thanks for adding the documentation. It highlights that the documentation needs a significant addition to describe the differences between a single Pipeline and a Pipeline defined within a multibranch project.

[MarkEWaite]

It is much better for me as a reviewer if you don't force push new changes once we've started reviewing. When a commit is force pushed, the comments may be dissociated from the current push. It is better for me as a reviewer if you push new commits. When the review is complete, it can be squash merged into the master branch before release.

[long76]

It is much better for me as a reviewer if you don't force push new changes once we've started reviewing. When a commit is force pushed, the comments may be dissociated from the current push. It is better for me as a reviewer if you push new commits. When the review is complete, it can be squash merged into the master branch before release.

i see. will create new commits

[MarkEWaite]

I'd prefer to remove the variable.

[MarkEWaite]

I would like to use Java 17 pattern matching instanceof instead of casting the result.

[long76]

@MarkEWaite still checking?

[long76]

@MarkEWaite ping

[MarkEWaite]

@MarkEWaite ping

Thanks. The change needs much more documentation. I won't have time to create that documentation for at least 2-3 weeks.

The documentation you've proposed needs to be expanded with explanatory paragraphs and it needs to move to the end of the examples section as its own independent example. This addition is not another case of shallow checkout, it is a distinct use case that needs to be separately documented.

[long76]

@MarkEWaite ping

Thanks. The change needs much more documentation. I won't have time to create that documentation for at least 2-3 weeks.

The documentation you've proposed needs to be expanded with explanatory paragraphs and it needs to move to the end of the examples section as its own independent example. This addition is not another case of shallow checkout, it is a distinct use case that needs to be separately documented.

i see. thanks. something like 2080375 needed?

[MarkEWaite]

i see. thanks. something like 2080375 needed?

That is a beginning, but it needs a significant addition to describe the differences between a single Pipeline and a Pipeline defined within a multibranch project and how resolveScm can be used to extract information from a previous checkout in the Pipeline. The current phrasing does not mention why the user would use it or more details about the context for its use. There is no explanation of the concepts involved in resolveScm and no link to more detailed documentation of resolveScm.

[long76]

i see. thanks. something like 2080375 needed?

That is a beginning, but it needs a significant addition to describe the differences between a single Pipeline and a Pipeline defined within a multibranch project and how resolveScm can be used to extract information from a previous checkout in the Pipeline. The current phrasing does not mention why the user would use it or more details about the context for its use. There is no explanation of the concepts involved in resolveScm and no link to more detailed documentation of resolveScm.

yes. i fix it to some extent. for now i don't know how better rewrite this)