Powershell Automation Examples

Powershell (7+) kick-starting material for automation, written with a lot of structure in place.

All examples are multi-platform, unless otherwise stated.

Example 1: Generate a Markdown Analytics Report from API Calls

Generates a sample markdown file and opens it for you in VSCode.

Context: use API calls to gather data and create a report in markdown. No use of local repos. Uses a local env file for secrets.

TODO:

• Make use of the cache folder and use cache loading

It will look something like this:

Structure

• 📂/scripts/
  • 📂/analytics/
    • do-api-analytics.ps1 - Actually does the analytics bit
  • 📂/cache/ (generated folder - ignored by git) - Holds the API data as a cache
  • 📂/general-utilities/
    • load-env.ps1 - Loads a .env into environment
  • 📂/markdown-snippets/
    • template-analytics.ps1 - Template for analytics with replaceable sections
  • 📂/output/ (generated folder - ignored by git) - Where the results file goes
    • api-results.md - Output markdown file
  • 📂/test-analytics/
    • test-do-api-analytics.ps1 - Tests for the analytics in this example
  • 📂/test-groups/
    • test-example1.ps1 - Tests for everything in this example
  • analyze-api-items.ps1 - Starting point. Does setup, does analysis, and shows results

How to run

Run the "Example 1" Run and Debug action in VSCode. Alternatively, you can run the scripts/analyze-api-items.ps1 script directly in powershell.

All Tests

• 📂/scripts/
  • 📂/test-analytics/
    • test-do-api-analytics.ps1
  • 📂/test-general-utilities/
    • test-load-env.ps1
    • sample.env - Sample env file for testing
  • 📂/test-groups/
    • test-all.ps1 - Runs all tests for all examples
      • 🚀 Tied to VSCode Launch Action "Run All Tests"
    • test-example1.ps1 - Tests for Example 1 (above)
      • 🚀 Tied to VSCode Launch Action "Example 1 Tests"

Note: Each example runs all tests for components used in that example, with overlap because they use common components. "Run All Tests/test-all" will only run each test once, without overlap.

---

Created by Elijah Fry, License MIT.