From 888e32d450e54011f63b52b349276e321b017a9b Mon Sep 17 00:00:00 2001 From: Jonathan Colon Date: Thu, 19 Feb 2026 20:32:34 -0400 Subject: [PATCH 1/3] Fix module name references from AsBuiltReport Charts to AsBuiltReport Chart in documentation --- CHANGELOG.md | 5 ++--- README.md | 22 +++++++++++++--------- 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 33f229d..2686bdf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# :arrows_clockwise: AsBuiltReport Charts Changelog +# :arrows_clockwise: AsBuiltReport Chart Changelog All notable changes to this project will be documented in this file. @@ -9,5 +9,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- Initial release of AsBuiltReport Charts, providing basic charting capabilities for AsBuiltReport data visualization. - +- Initial release of AsBuiltReport Chart, providing basic charting capabilities for AsBuiltReport data visualization. \ No newline at end of file diff --git a/README.md b/README.md index 450ca5b..a2a1e99 100644 --- a/README.md +++ b/README.md @@ -29,41 +29,42 @@

-# As Built Report Charts +# AsBuiltReport.Chart ## :exclamation: THIS ASBUILTREPORT MODULE IS CURRENTLY IN DEVELOPMENT AND MIGHT NOT YET BE FUNCTIONAL ❗ -AsBuiltReport Charts As Built Report is a PowerShell module which works in conjunction with [AsBuiltReport.Core](https://github.com/AsBuiltReport/AsBuiltReport.Core). +AsBuiltReport.Chart As Built Report is a PowerShell module which works in conjunction with [AsBuiltReport.Core](https://github.com/AsBuiltReport/AsBuiltReport.Core). [AsBuiltReport](https://github.com/AsBuiltReport/AsBuiltReport) is an open-sourced community project which utilises PowerShell to produce as-built documentation in multiple document formats for multiple vendors and technologies. Please refer to the AsBuiltReport [website](https://www.asbuiltreport.com) for more detailed information about this project. # :beginner: Getting Started -Below are the instructions on how to install, AsBuiltReport Charts. + +Below are the instructions on how to install, AsBuiltReport Chart. ## :floppy_disk: Supported Versions - -The AsBuiltReport Charts supports the following Charts versions; + ### PowerShell + This report is compatible with the following PowerShell versions; | Windows PowerShell 5.1 | PowerShell 7 | | :--------------------: | :----------------: | -| :x: | :white_check_mark: | +| :white_check_mark: | :white_check_mark: | ## πŸ—ΊοΈ Language Support -The AsBuiltReport Charts As Built Report supports the following languages; +The AsBuiltReport Chart As Built Report supports the following languages; - English (US) (Default) ## :wrench: System Requirements -PowerShell 7, and the following PowerShell modules are required for generating a AsBuiltReport Charts. +PowerShell 7, and the following PowerShell modules are required for generating a AsBuiltReport Chart. - [AsBuiltReport.Core Module](https://www.powershellgallery.com/packages/AsBuiltReport.Core/) @@ -84,22 +85,25 @@ update-module AsBuiltReport.Chart -Force ``` ### GitHub + If you are unable to use the PowerShell Gallery, you can still install the module manually. Ensure you repeat the following steps for the [system requirements](https://github.com/AsBuiltReport/AsBuiltReport.Chart#wrench-system-requirements) also. 1. Download the code package / [latest release](https://github.com/AsBuiltReport/AsBuiltReport.Chart/releases/latest) zip from GitHub 2. Extract the zip file 3. Copy the folder `AsBuiltReport.Chart` to a path that is set in `$env:PSModulePath`. 4. Open a PowerShell terminal window and unblock the downloaded files with + ```powershell $path = (Get-Module -Name AsBuiltReport.Chart -ListAvailable).ModuleBase; Unblock-File -Path $path\*.psd1; Unblock-File -Path $path\Src\Public\*.ps1; Unblock-File -Path $path\Src\Private\*.ps1 ``` + 5. Close and reopen the PowerShell terminal window. _Note: You are not limited to installing the module to those example paths, you can add a new entry to the environment variable PSModulePath if you want to use another path._ ### Options -The **Options** schema allows certain options within the report to be toggled on or off. +The **Options** schema allows certain options within the report to be toggled on or off. ## :computer: Examples From e2a98f2f8b8a5101aed13f788aac917e57143d8f Mon Sep 17 00:00:00 2001 From: Jonathan Colon Date: Thu, 19 Feb 2026 20:44:08 -0400 Subject: [PATCH 2/3] Enhance Release workflow to include tweeting and Bluesky posting for new releases; update README for clarity on module functionality --- .github/workflows/Release.yml | 52 +++++++++++++++++------------------ README.md | 4 +-- 2 files changed, 28 insertions(+), 28 deletions(-) diff --git a/.github/workflows/Release.yml b/.github/workflows/Release.yml index 5398f30..63ad3ee 100644 --- a/.github/workflows/Release.yml +++ b/.github/workflows/Release.yml @@ -41,29 +41,29 @@ jobs: shell: pwsh run: | Publish-Module -Path .\AsBuiltReport.Chart\ -NuGetApiKey ${{ secrets.PSGALLERY_API_KEY }} -Verbose - # tweet: - # needs: publish-to-psgallery - # runs-on: ubuntu-latest - # steps: - # - uses: Eomm/why-don-t-you-tweet@v2 - # # We don't want to tweet if the repository is not a public one - # if: ${{ !github.event.repository.private }} - # with: - # # GitHub event payload - # # https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release - # tweet-message: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #AsBuiltReport #PowerShell" - # env: - # TWITTER_CONSUMER_API_KEY: ${{ secrets.TWITTER_CONSUMER_API_KEY }} - # TWITTER_CONSUMER_API_SECRET: ${{ secrets.TWITTER_CONSUMER_API_SECRET }} - # TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }} - # TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }} - # bsky-post: - # needs: publish-to-psgallery - # runs-on: ubuntu-latest - # steps: - # - uses: zentered/bluesky-post-action@v0.3.0 - # with: - # post: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #AsBuiltReport #PowerShell" - # env: - # BSKY_IDENTIFIER: ${{ secrets.BSKY_IDENTIFIER }} - # BSKY_PASSWORD: ${{ secrets.BSKY_PASSWORD }} + tweet: + needs: publish-to-psgallery + runs-on: ubuntu-latest + steps: + - uses: Eomm/why-don-t-you-tweet@v2 + # We don't want to tweet if the repository is not a public one + if: ${{ !github.event.repository.private }} + with: + # GitHub event payload + # https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release + tweet-message: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #AsBuiltReport #PowerShell" + env: + TWITTER_CONSUMER_API_KEY: ${{ secrets.TWITTER_CONSUMER_API_KEY }} + TWITTER_CONSUMER_API_SECRET: ${{ secrets.TWITTER_CONSUMER_API_SECRET }} + TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }} + TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }} + bsky-post: + needs: publish-to-psgallery + runs-on: ubuntu-latest + steps: + - uses: zentered/bluesky-post-action@v0.3.0 + with: + post: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #AsBuiltReport #PowerShell" + env: + BSKY_IDENTIFIER: ${{ secrets.BSKY_IDENTIFIER }} + BSKY_PASSWORD: ${{ secrets.BSKY_PASSWORD }} diff --git a/README.md b/README.md index a2a1e99..f881ef9 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ ## :exclamation: THIS ASBUILTREPORT MODULE IS CURRENTLY IN DEVELOPMENT AND MIGHT NOT YET BE FUNCTIONAL ❗ -AsBuiltReport.Chart As Built Report is a PowerShell module which works in conjunction with [AsBuiltReport.Core](https://github.com/AsBuiltReport/AsBuiltReport.Core). +AsBuiltReport.Chart is a PowerShell module which works in conjunction with [AsBuiltReport.Core](https://github.com/AsBuiltReport/AsBuiltReport.Core). [AsBuiltReport](https://github.com/AsBuiltReport/AsBuiltReport) is an open-sourced community project which utilises PowerShell to produce as-built documentation in multiple document formats for multiple vendors and technologies. @@ -42,7 +42,7 @@ Please refer to the AsBuiltReport [website](https://www.asbuiltreport.com) for m # :beginner: Getting Started -Below are the instructions on how to install, AsBuiltReport Chart. +The following simple list of instructions will get you started with the AsBuiltReport.Chart module. ## :floppy_disk: Supported Versions From 58a75a91480ae3b16e0361cf3907f8a3adce26b8 Mon Sep 17 00:00:00 2001 From: Jonathan Colon Date: Thu, 19 Feb 2026 21:17:20 -0400 Subject: [PATCH 3/3] Add CodeQL analysis workflow for automated code quality checks --- .github/workflows/{codeql.yml => Codeql.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{codeql.yml => Codeql.yml} (100%) diff --git a/.github/workflows/codeql.yml b/.github/workflows/Codeql.yml similarity index 100% rename from .github/workflows/codeql.yml rename to .github/workflows/Codeql.yml