-
-
Notifications
You must be signed in to change notification settings - Fork 100
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
2025.1.1 Release #213
Conversation
… into se-mkdocs-01
Risk Ratings!
…w more issue types.
Strict Typing + Updated Risk
Use GitHub IO URL
Update mkdocs.yml
Re-enable commit step
Update Deploy MkDocs.yml
Set trigger to push to testing branch
Update Deploy MkDocs.yml
case sensitive docs dir
Update mkdocs.yml
Add trigger on PR and manual workflow dispatch
Update Deploy MkDocs.yml
Because protections.
Create index.md
Update Deploy MkDocs.yml
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
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
|
||
# 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
Uses Step
|
||
# 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
Syncing main to testing in preparation for 2025.1.1!