Repository Template Structure

Description

Overview of the repository structure used in the Automation Team. This template serves as a starting point for new repositories, ensuring consistency and best practices across projects.

Requirements

1. Git for Windows should be installed on your machine.
2. Ensure name and email has been configured in Git.

1. Clone the repository to your local machine.

   git clone https://novonordiskit@dev.azure.com/novonordiskit/GITO-PI_Automation/_git/ARepositoryTemplate_Basic

2. Create a empty repository in your Azure DevOps Project and clone that to your pc.

3. Copy the files from “ARepositoryTemplate_Basic” to your new repository.

4. Change the files according to your project requirements.

File Structure Explanation

• Directory.vscode

  • settings.json Good defaults to use in VScode
• Directorydocs Developer Portal Documentation folder

  • …
• Directorymodules Powershell Modules

  • Module01
  • Module02
• Directorypipeline Azure DevOps Pipeline folder

  • azure-pipelines.yml Main pipeline file
• Directorytest Pester Test folder

  • Pester.ps1 File be the pipeline to run the tests
  • Pester01.Help.Quality.Tests.ps1 Ensure that all .ps1 files have proper help comments
  • Pester02.Module.Help.Quality.Tests.ps1 Ensure that all module files have proper help comments
  • Pester03.Code.Quality.Tests.ps1 PSScriptAnalyzer Tests