Skip to content

Commit 6b11c8a

Browse files
🩹 [Patch]: Update workflow triggers and doc action inputs (#24)
## Description This pull request includes several changes to the GitHub Actions workflow, documentation, and action configuration files. The main changes are the addition of a scheduled trigger to the workflow, updates to the descriptions in the documentation and action configuration, and a minor update to the PowerShell script. Workflow and scheduling updates: * [`.github/workflows/Action-Test.yml`](diffhunk://#diff-a12ae5c885b0673c0ff6f70c2670886907590d624626e07da4c52e01aeaf56a4L5-R9): Added a scheduled trigger to the workflow to run it daily at midnight. Documentation updates: * [`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L39-R42): Updated the description for the `Version` input to specify that it refers to the version of the GitHub module to be installed. Action configuration updates: * [`action.yml`](diffhunk://#diff-1243c5424efaaa19bd8e813c5e6f6da46316e63761421b3e5f5c8ced9a36e6b6L18-R18): Updated the description for the `Version` input to specify that it refers to the version of the GitHub module to be installed. * [`action.yml`](diffhunk://#diff-1243c5424efaaa19bd8e813c5e6f6da46316e63761421b3e5f5c8ced9a36e6b6L37-R37): Removed the `-Verbose` flag from the PowerShell script execution. Script updates: * [`scripts/main.ps1`](diffhunk://#diff-dc2e5a659836b1b73abb03421c567f5018c2755677c4a0aa764cb26117b68011R5): Added a blank line after the `param()` declaration for better readability. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
1 parent 2d11928 commit 6b11c8a

File tree

4 files changed

+12
-7
lines changed

4 files changed

+12
-7
lines changed

.github/workflows/Action-Test.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@ name: Action-Test
22

33
run-name: "Action-Test - [${{ github.event.pull_request.title }} #${{ github.event.pull_request.number }}] by @${{ github.actor }}"
44

5-
on: [pull_request]
5+
on:
6+
workflow_dispatch:
7+
pull_request:
8+
schedule:
9+
- cron: '0 0 * * *'
610

711
concurrency:
812
group: ${{ github.workflow }}-${{ github.ref }}

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ The Initialize-PSModule action will prepare the runner for the PSModule framewor
3636

3737
| Name | Description | Required | Default |
3838
| - | - | - | - |
39-
| `Debug` | Enable debug output. | false | `'false'` |
40-
| `Verbose` | Enable verbose output. | false | `'false'` |
41-
| `Version` | Specifies the version of the resource to be returned. | false | |
42-
| `Prerelease` | Allow prerelease versions if available. | false | `'false'` |
39+
| `Debug` | Enable debug output. | `false` | `'false'` |
40+
| `Verbose` | Enable verbose output. | `false` | `'false'` |
41+
| `Version` | Specifies the version of the GitHub module to be installed. The value must be an exact version. | `false` | |
42+
| `Prerelease` | Allow prerelease versions if available. | `false` | `'false'` |
4343

4444
## Example
4545

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ inputs:
1515
required: false
1616
default: 'false'
1717
Version:
18-
description: Specifies the version of the resource to be returned.
18+
description: Specifies the version of the GitHub module to be installed. The value must be an exact version.
1919
required: false
2020
Prerelease:
2121
description: Allow prerelease versions if available.
@@ -34,4 +34,4 @@ runs:
3434
Version: ${{ inputs.Version }}
3535
Script: |
3636
# Initialize-PSModule
37-
. "${{ github.action_path }}\scripts\main.ps1" -Verbose
37+
. "${{ github.action_path }}\scripts\main.ps1"

scripts/main.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[CmdletBinding()]
44
param()
5+
56
$requiredModules = @{
67
Utilities = @{}
78
'powershell-yaml' = @{}

0 commit comments

Comments
 (0)