Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2025.1.1 Release #213

Merged
merged 104 commits into from
Jan 1, 2025
Merged

2025.1.1 Release #213

merged 104 commits into from
Jan 1, 2025

Conversation

jakehildreth
Copy link
Owner

@jakehildreth jakehildreth commented Jan 1, 2025

Syncing main to testing in preparation for 2025.1.1!

jakehildreth and others added 27 commits December 29, 2024 07:59
Use GitHub IO URL
Re-enable commit step
Set trigger to push to testing branch
case sensitive docs dir
Add trigger on PR and manual workflow dispatch
Because protections.
Comment on lines +11 to +32
runs-on: windows-latest
steps:
- name: ✅ Checkout Repository
uses: actions/checkout@v4
- name: 📁 Display the Path
shell: pwsh
run: echo ${env:PATH}
- name: 🔢 Display the Version
shell: pwsh
run: $PSVersionTable
- name: 📖 Create and Package External PowerShell Help
shell: pwsh
run: |
Install-Module -Name PlatyPS -Scope CurrentUser -Force -SkipPublisherCheck
Import-Module -Name PlatyPS -Force
#Copy-Item ".\Help\en-US\Locksmith-help.xml" ".\Help\en-US"
$params = @{
CabFilesFolder = ".\en-US"
LandingPagePath = ".\Docs\Locksmith.md"
OutputFolder = ".\en-US"
}
New-ExternalHelpCab @params

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions Job or Workflow does not set permissions
Comment on lines +21 to +64
runs-on: ubuntu-latest

steps:
- name: ✅ Checkout Repository
uses: actions/checkout@v4

- name: 🐍 Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.x' # specify the Python version

- name: ➕ Install Dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material

- name: 👷‍♂️ Build & Deploy MkDocs
run: |
mkdocs build
mkdocs gh-deploy --force

# Combine markdown files to create the MkDocs index and the repository readme file.
- name: 📖 Update Index & Readme
shell: pwsh
run: |
Write-Output 'Updating Docs\Index.md & \Readme.md'
Copy-Item README.md Docs/index.md
# [int16]$LineNumber = (Select-String -Path '.\docs\index.md' -Pattern 'Summary' -List).LineNumber + 1
# $IndexTop = Get-Content -Path ./docs/index.md -TotalCount $LineNumber
# $ModuleContent = Get-Content -Path ./docs/Locksmith.md | Select-Object -Skip 12
# $FooterContent = "`n</Details>`n"
# $CombinedContent = $IndexTop + $ModuleContent + $FooterContent
# $CombinedContent | Set-Content -Path ./docs/index.md
# $ModuleContent = $ModuleContent.Replace( '](' , '](./docs/' )
# $CombinedContent = $IndexTop + $ModuleContent
# $CombinedContent | Set-Content -Path ./README.md
# Copy-Item ./docs/index.md ./README.md

# NOTE: git-auto-commit-action only runs on Linux-based platforms.
- name: 💾 Commit Changes
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: 'Copy MkDocs README to index'
file_pattern: 'README.md Docs/index.md'

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions Job or Workflow does not set permissions

# NOTE: git-auto-commit-action only runs on Linux-based platforms.
- name: 💾 Commit Changes
uses: stefanzweifel/git-auto-commit-action@v5

Check warning

Code scanning / CodeQL

Unpinned tag for a non-immutable Action in workflow Medium

Unpinned 3rd party Action '📖 Deploy MkDocs to GitHub' step
Uses Step
uses 'stefanzweifel/git-auto-commit-action' with ref 'v5', not a pinned commit hash

# MegaLinter
- name: MegaLinter

# You can override MegaLinter flavor used to have faster performances
# More info at https://megalinter.io/flavors/
# The dotnet flavor includes PowerShell, MD, YAML, JSON, spelling, and more.
uses: oxsecurity/megalinter/flavors/dotnet@v7.7.0
uses: oxsecurity/megalinter/flavors/dotnet@v8.3.0

Check warning

Code scanning / CodeQL

Unpinned tag for a non-immutable Action in workflow Medium

Unpinned 3rd party Action 'MegaLinter' step
Uses Step: ml
uses 'oxsecurity/megalinter/flavors/dotnet' with ref 'v8.3.0', not a pinned commit hash
@jakehildreth jakehildreth marked this pull request as ready for review January 1, 2025 14:56
@jakehildreth jakehildreth merged commit 0319732 into main Jan 1, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants