Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 4 additions & 12 deletions .github/workflows/Build Module.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,13 @@ on:

workflow_dispatch:

permissions:
contents: read

jobs:
test:
name: 🧪 Run Tests
runs-on: ubuntu-latest
runs-on: windows-latest
strategy:
fail-fast: false

Expand All @@ -31,11 +34,6 @@ jobs:
- name: ✅ Checkout Repository
uses: actions/checkout@v4

# Uncomment below to explore what modules/variables/env variables are available in the build image
- name: 📦 Modules and Variables Display
shell: pwsh
run: Get-Module -ListAvailable; (Get-Variable).GetEnumerator() | Sort-Object Name | Out-String; (Get-ChildItem env:*).GetEnumerator() | Sort-Object Name | Out-String

- name: 🥾 Bootstrap
shell: pwsh
run: ./actions_bootstrap.ps1
Expand All @@ -57,9 +55,3 @@ jobs:
name: zip-archive
path: .\src\Archive
if-no-files-found: warn
# git-auto-commit-action only runs on Linux-based platforms.

- name: 💾 Commit Changes
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: 'Commit Build'
160 changes: 96 additions & 64 deletions docs/Clear-OldIISLog.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,97 @@
---
external help file: TheCleaners-help.xml
Module Name: TheCleaners
online version:
schema: 2.0.0
---

# Clear-OldIISLog

## SYNOPSIS
A script to clean out old IIS log files.

## SYNTAX

```
Clear-OldIISLog [[-Days] <Int16>] [<CommonParameters>]
```

## DESCRIPTION
This script will clean out IIS log files older than x days.

## EXAMPLES

### EXAMPLE 1
```
Clear-OldIISLogFile -Days 60
```

Removes all IIS log files that are older than 60 days.

## PARAMETERS

### -Days
The number of days to keep log files.
The default is 30 days.

```yaml
Type: Int16
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: 60
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction.
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES
If the WebAdministration module is available, it will use that to check the specific log file locations for
each web site.
Otherwise, it checks the assumed default log folder location and the registry for the IIS
log file location.

To Do: Add a summary of which blocks were run and possibly a count of log files removed.

---
external help file: TheCleaners-help.xml
Module Name: TheCleaners
online version:
schema: 2.0.0
---

# Clear-OldIISLog

## SYNOPSIS
A script to clean out old IIS log files.

## SYNTAX

```

Check notice on line 15 in docs/Clear-OldIISLog.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/Clear-OldIISLog.md#L15

Fenced code blocks should have a language specified
Clear-OldIISLog [[-Days] <Int16>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```

## DESCRIPTION
This script will clean out IIS log files older than x days.

## EXAMPLES

### EXAMPLE 1
```
Clear-OldIISLog -Days 60
```

Removes all IIS log files that are older than 60 days.

## PARAMETERS

### -Days
The number of days to keep log files.
The default is 60 days.

```yaml
Type: Int16
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: 60
Accept pipeline input: False
Comment thread
SamErde marked this conversation as resolved.
Accept wildcard characters: False
```

### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Confirm
Prompts you for confirmation before running the cmdlet.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction.
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES
If the WebAdministration module is available, it will use that to check the specific log file locations for
each web site.
Otherwise, it checks the assumed default log folder location and the registry for the IIS
log file location.

To Do: Add a summary of which blocks were run and possibly a count of log files removed.

## RELATED LINKS
114 changes: 57 additions & 57 deletions docs/Start-Cleaning.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,58 @@
---
external help file: TheCleaners-help.xml
Module Name: TheCleaners
online version:
schema: 2.0.0
---
# Start-Cleaning
## SYNOPSIS
Show the commands you can give The Cleaners.
## SYNTAX
```
Start-Cleaning [-Dedication] [<CommonParameters>]
```
## DESCRIPTION
Get started with a menu of services The Cleaners can offer.
## EXAMPLES
### EXAMPLE 1
```
Start-Cleaning
```
View the menu of services that TheCleaners provide.
## PARAMETERS
### -Dedication
Show dedication
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction.
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
---
external help file: TheCleaners-help.xml
Module Name: TheCleaners
online version:
schema: 2.0.0
---

# Start-Cleaning

## SYNOPSIS
Show the commands you can give The Cleaners.

## SYNTAX

```

Check notice on line 15 in docs/Start-Cleaning.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/Start-Cleaning.md#L15

Fenced code blocks should have a language specified
Start-Cleaning [-Dedication] [<CommonParameters>]
```

## DESCRIPTION
Get started with a menu of services The Cleaners can offer.

## EXAMPLES

### EXAMPLE 1
```
Start-Cleaning
```

View the menu of services that TheCleaners provide.

## PARAMETERS

### -Dedication
Show a short dedication before the command menu.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction.
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
66 changes: 0 additions & 66 deletions src/Tests/SkipUnit/ExportedFunctions.Tests.ps1

This file was deleted.

Loading
Loading