Set custom path for pipeline configuration file in the source code repository

[Jefffrey]

PR Details

Enable configuration of custom paths for template and config files when retrieving them from the source code repository for Multibranch projects to address issue #99

Description

TemplateBranchProjectFactory and TemplateMultiBranchProjectFactory have been modified to store a new String configurationPath (which defaults to pipeline_config.groovy) and allows users to specify which path in the repository to fetch the pipeline configuration file from instead of always fetching from root. Also enabled this same selection for the pipeline template file via field String scriptPath which defaults to Jenkinsfile.

MultibranchTemplateFlowDefinition has been updated to account for these fields, and thus the PipelineConfigurationAggregator and PipelineTemplateResolver classes now have extra behaviour for this definition in case a custom path has been specified.

Documentation, resources been updated and a new unit test added.

How Has This Been Tested

Running just test as well as some local testing with just run

Types of Changes

• Added Unit Testing
• Docs change / refactoring / dependency upgrade
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• I have added the appropriate label for this PR
• If necessary, I have updated the documentation accordingly.
• All new and existing tests passed.

[steven-terrana]

thanks @Jefffrey!

appreciate the PR - looks great.
testing it out now.

[steven-terrana]

Thanks for writing the tests. I ran a bunch of manual tests around dot files (.jte.groovy) and nested file paths and it's all working great.

Might be a separate PR.. but..

any thoughts around how you think JTE should handle the situation where the Pipeline Template or the Pipeline Configuration File can't be found?

Right now, JTE doesn't require a repository level Pipeline Configuration file so it doesn't log any output when it doesn't find one.

I feel like if the user defines a specific path, then they're probably anticipating that file be present and we should at least log a warning if it wasn't found or potentially even fail the build.

thoughts?

[Jefffrey]

hey @steven-terrana

yeah I agree with the thought process of if they specify a path, it should error if the path doesn't exist. Don't particularly like the thought of the error occurring and being buried in the logs