Skip to content

manning-liveproject/package-the-module-lp-author

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

package-the-module-lp-author

Repository for liveProject: Package the Module This repository contains starter files for the third project in the series - these very files are actually a full solution for the second project about testing the PowerShell module.

How to get started

After completing the setup and installing the required dependencies for this project, and forking and cloning this repository, you should be able to run build.ps1 file which would create a fully functioning module in the build directory. At this point the project is good to go, please follow the steps from the workflow. There's also a GitHub workflow to build the module automatically upon pushing it to the Main branch - you might need to enable the workflow.

The integration tests go throug steps of creating, updating and removing a temporaily Github reposiotry - the PAT token used authenticate to GitHub needs to have rights to manage repositories for integration tests to succeeed.

The Action requires:

  • Secret named: GHTOKEN - this is a PAT token for action to use for integration tests
  • Variable named: TESTOWNER - this is a username of the user for which test repository is being created

Significant files and folders

  • build.ps1 file - the main building file. This file takes all source files from the /source/ directory and compiles the module into /build/ directory
  • /source/ directory - contains all .ps1 files, and module manifest in the .psd1 file. File in the /source/public/ directory are usable by the user after building and importing the module
  • /.github/workflows/ci.yml file - the GitHub action which builds the module
  • /test/ directory - contains all unit and integration tests. All tests can be executed with /test/test.ps1 and /test/lint.ps1

About

Repository for liveProject: Package the Module

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •