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

Enhancements #83

Merged
merged 9 commits into from
May 18, 2024
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
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"cSpell.enabled": true,
"cSpell.words": [
"Allman",
"amazonlinux",
"APACHELICENSE",
"Aperta",
"appveyor",
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@

Branch | Windows - PowerShell | Windows - pwsh | Linux | MacOS
--- | --- | --- | --- | --- |
main | ![Build Status Windows PowerShell Main](https://github.com/techthoughts2/Catesta/workflows/Catesta-Windows-PowerShell/badge.svg?branch=main) | ![Build Status Windows pwsh Main](https://github.com/techthoughts2/Catesta/workflows/Catesta-Windows-pwsh/badge.svg?branch=main) | ![Build Status Linux Main](https://github.com/techthoughts2/Catesta/workflows/Catesta-Linux/badge.svg?branch=main) | ![Build Status MacOS Main](https://github.com/techthoughts2/Catesta/workflows/Catesta-MacOS/badge.svg?branch=main)
Enhancements | ![Build Status Windows PowerShell Enhancements](https://github.com/techthoughts2/Catesta/workflows/Catesta-Windows-PowerShell/badge.svg?branch=Enhancements) | ![Build Status Windows pwsh Enhancements](https://github.com/techthoughts2/Catesta/workflows/Catesta-Windows-pwsh/badge.svg?branch=Enhancements) | ![Build Status Linux Enhancements](https://github.com/techthoughts2/Catesta/workflows/Catesta-Linux/badge.svg?branch=Enhancements) | ![Build Status MacOS Enhancements](https://github.com/techthoughts2/Catesta/workflows/Catesta-MacOS/badge.svg?branch=Enhancements)
main | [![Catesta-Windows-PowerShell](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows.yml/badge.svg?branch=main)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows.yml) | [![Catesta-Windows-pwsh](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows_Core.yml/badge.svg?branch=main)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows_Core.yml)| [![Catesta-Linux](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Linux.yml/badge.svg?branch=main)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Linux.yml) | [![Catesta-MacOS](https://github.com/techthoughts2/Catesta/actions/workflows/wf_MacOS.yml/badge.svg?branch=main)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_MacOS.yml)
Enhancements | [![Catesta-Windows-PowerShell](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows.yml/badge.svg?branch=Enhancements)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows.yml) | [![Catesta-Windows-pwsh](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows_Core.yml/badge.svg?branch=Enhancements)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows_Core.yml) | [![Catesta-Linux](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Linux.yml/badge.svg?branch=Enhancements)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Linux.yml) | [![Catesta-MacOS](https://github.com/techthoughts2/Catesta/actions/workflows/wf_MacOS.yml/badge.svg?branch=Enhancements)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_MacOS.yml)

## Synopsis

Expand Down
4 changes: 2 additions & 2 deletions actions_bootstrap.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ $modulesToInstall = New-Object System.Collections.Generic.List[object]
# https://github.com/nightroman/Invoke-Build
[void]$modulesToInstall.Add(([PSCustomObject]@{
ModuleName = 'InvokeBuild'
ModuleVersion = '5.10.5'
ModuleVersion = '5.11.1'
}))
# https://github.com/PowerShell/PSScriptAnalyzer
[void]$modulesToInstall.Add(([PSCustomObject]@{
ModuleName = 'PSScriptAnalyzer'
ModuleVersion = '1.21.0'
ModuleVersion = '1.22.0'
}))
# https://github.com/PowerShell/platyPS
# older version used due to: https://github.com/PowerShell/platyPS/issues/457
Expand Down
37 changes: 37 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,43 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.11.0]

- Catesta template module changes
- CI/CD Changes:
- GitHub Actions with CodeBuild (***new***):
- Added support for new CI/CD option which leverages GitHub Actions that run on AWS CodeBuild. This option generates both GitHub Action workflows as well as CFN templates for deployment to AWS for creating CodeBuild projects that integrate with the actions of your GitHub project.
- AWS CodeBuild:
- GitLab added as a supported source for CodeBuild projects
- Each CodeBuild project now has its own `AWS::Logs::LogGroup` created with a configurable retention policy.
- Minor changes to formatting in CFNs to satisfy new `cfn-lint` requirements.
- Windows CodeBuild project containers upgraded to latest image:
- `aws/codebuild/windows-base:2019-2.0` to `aws/codebuild/windows-base:2019-3.0`
- Linux CodeBuild project image now parameterized (Previously hard set to: `aws/codebuild/standard:7.0`) and supports either:
- `aws/codebuild/standard:7.0` (default)
- `aws/codebuild/amazonlinux2-x86_64-standard:5.0`
- Updated CodeCommit based builds Lambda triggers from `python3.9` to `python3.12` runtime.
- Buildspec updates:
- `buildspec_pwsh_linux.yml` updated to dot net 8.
- `buildspec_pwsh_windows.yml` updated to dot net 8.
- AWS.Tools.Common bumped from `4.1.133` to `4.1.572`
- GitHub Actions:
- Workflow actions now include the module name in the action name
- GitLab CI/CD:
- Updated from `shared-windows` and `windows-1809` tagged shared runners to `saas-windows-medium-amd64` and `windows-2022` to support GitLab 17.
- pwsh is now pre-installed on the 2022 runner (albeit an older version) so the `choco` install for `pwsh` has been commented out. *Note: if you want the latest version of pwsh, uncomment the `choco` command*
- InvokeBuild bumped from `5.10.5` to `5.11.1`
- PSScriptAnalyzer bumped from `1.21.0` to `1.22.0`
- Catesta primary module changes
- Added additional tests for:
- new AWS changes
- new GitHub Actions with Codebuild capabilities
- InvokeBuild bumped from `5.10.5` to `5.11.1`
- PSScriptAnalyzer bumped from `1.21.0` to `1.22.0`
- Documentation updates
- Updated README to use new badge urls for action builds
- Updated Catesta - AWS CodeBuild Integration

## [2.4.0]

- Catesta template module changes
Expand Down
10 changes: 7 additions & 3 deletions docs/Catesta-Basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ New-VaultProject -DestinationPath $outPutPath
* [M] Module Only
* [G] GitHub Actions
* [C] AWS CodeBuild
* [S] GitHub Actions on AWS CodeBuild
* [P] Appveyor
* [L] GitLab CI/CD
* [B] BitBucket Pipelines
Expand Down Expand Up @@ -70,6 +71,7 @@ The options listed in the prompt represent the different CI/CD tools that Catest
[M] Module Only
[G] GitHub Actions
[C] AWS CodeBuild
[S] GitHub Actions on AWS CodeBuild
[P] Appveyor
[L] GitLab CI/CD
[B] BitBucket Pipelines
Expand All @@ -84,11 +86,13 @@ It's important to note that the choice you make here will impact the setup and c

If you need help with the options or are unsure which to choose, you can review additional Catesta documentation that covers the process of each CI/CD integration in depth:

* [Catesta - AWS Doc](catesta_cicd/Catesta-AWS.md)
* [Catesta - GitHub Actions Doc](catesta_cicd/Catesta-GHActions.md)
* [Catesta - Azure Pipelines Doc](catesta_cicd/Catesta-Azure.md)
* [Catesta - Bitbucket Doc](catesta_cicd/Catesta-Bitbucket.md)
* [Catesta - AWS CodeBuild Doc](catesta_cicd/Catesta-AWS.md)
* [Catesta - GitHub Actions on AWS CodeBuild Doc](catesta_cicd/Catesta-GHActionsAWSCodeBuild.md)
* [Catesta - AppVeyor Doc](catesta_cicd/Catesta-AppVeyor.md)
* [Catesta - GitLab Doc](catesta_cicd/Catesta-GitLab.md)
* [Catesta - Bitbucket Doc](catesta_cicd/Catesta-Bitbucket.md)
* [Catesta - Azure Pipelines Doc](catesta_cicd/Catesta-Azure.md)

#### Understanding Build Configuration Selection

Expand Down
60 changes: 37 additions & 23 deletions docs/Catesta-ModuleSchema.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ choices:
help : CI/CD using GitHub Actions.
value : CODEBUILD
help : CI/CD using AWS CodeBuild
value : GHACODEBUILD
help : CI/CD using GitHub Actions running on AWS CodeBuild.
value : APPVEYOR
help : CI/CD using AWS Appveyor
value : GITLAB
Expand All @@ -56,7 +58,7 @@ choices:
value : windows
help : Adds a Windows PowerShell based Workflow action.
value : pwshcore
help : Adds a Windows pwsh based pipeline job.
help : Adds a Windows pwsh based Workflow action.
value : linux
help : Adds a Linux based Workflow action.
value : macos
Expand All @@ -77,6 +79,17 @@ name : S3Bucket
type : text
default : PSGallery

name : GitHubACBOptions
type : multichoice
condition : $PLASTER_PARAM_CICD -eq 'GHACODEBUILD'
choices:
value : ps
help : Adds a Windows PowerShell based Workflow action powered by CodeBuild
value : pwshcore
help : Adds a Windows pwsh based Workflow action powered by CodeBuild.
value : pwsh
help : Adds a Linux based Workflow action powered by CodeBuild.

name : AppveyorOptions
type : multichoice
condition : $PLASTER_PARAM_CICD -eq 'APPVEYOR'
Expand Down Expand Up @@ -236,28 +249,29 @@ The example below showcases all the available options for the `New-ModuleProject
```powershell
$moduleParameters = @{

VAULT = 'text'
ModuleName = 'text'
Description = 'text'
Version = '0.0.1'
FN = 'user full name'
CICD = 'GITHUB'
GitHubAOptions = 'windows','pwshcore','linux','macos'
AWSOptions = 'ps','pwshcore','pwsh'
AppveyorOptions = 'windows','pwshcore','linux','macos'
GitLabOptions = 'windows','pwshcore','linux'
AzureOptions = 'windows','pwshcore','linux','macos'
RepoType = 'GITHUB'
License = 'MIT'
Changelog = 'CHANGELOG'
COC = 'CONDUCT'
Contribute = 'CONTRIBUTING'
Security = 'SECURITY'
ReadtheDocs = 'READTHEDOCS'
RTDTheme = 'READTHEDOCSTHEME'
CodingStyle = 'Stroustrup'
Help = 'Yes'
Pester = '5'
VAULT = 'text'
ModuleName = 'text'
Description = 'text'
Version = '0.0.1'
FN = 'user full name'
CICD = 'GITHUB'
GitHubAOptions = 'windows','pwshcore','linux','macos'
AWSOptions = 'ps','pwshcore','pwsh'
GitHubACBOptions = 'ps','pwshcore','pwsh'
AppveyorOptions = 'windows','pwshcore','linux','macos'
GitLabOptions = 'windows','pwshcore','linux'
AzureOptions = 'windows','pwshcore','linux','macos'
RepoType = 'GITHUB'
License = 'MIT'
Changelog = 'CHANGELOG'
COC = 'CONDUCT'
Contribute = 'CONTRIBUTING'
Security = 'SECURITY'
ReadtheDocs = 'READTHEDOCS'
RTDTheme = 'READTHEDOCSTHEME'
CodingStyle = 'Stroustrup'
Help = 'Yes'
Pester = '5'


}
Expand Down
2 changes: 1 addition & 1 deletion docs/Catesta.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Module Name: Catesta
Module Guid: 6796b193-9013-468a-b022-837749af2d06
Download Help Link: NA
Help Version: 2.4.0
Help Version: 2.11.0
Locale: en-US
---

Expand Down
Binary file modified docs/assets/AWS/AWSCodeBuildBitbucket.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/AWS/AWSCodeBuildGitHub.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/AWS/AWSCodeBuildGitLab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/catesta_cicd_integrations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
165 changes: 164 additions & 1 deletion docs/assets/diagrams/catesta_aws_codebuild_bitbucket.drawio

Large diffs are not rendered by default.

159 changes: 158 additions & 1 deletion docs/assets/diagrams/catesta_aws_codebuild_github.drawio

Large diffs are not rendered by default.

Loading
Loading