Skip to content
Closed
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
10 changes: 3 additions & 7 deletions .github/workflows/api-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,9 @@ on:
paths:
- docfx/**

permissions:
id-token: write
pages: write

jobs:
deploy:
name: Build and Deploy API docs to github-pages
name: Build and Deploy v1 API docs to github-pages
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
Expand All @@ -38,11 +34,11 @@ jobs:
with:
path: docfx/_site

- name: v1_release Repository Dispatch ${{ github.ref_name }}
- name: Terminal.GuiV1Docs Repository Dispatch ${{ github.ref_name }}
if: github.ref_name == 'v1_release'
uses: peter-evans/repository-dispatch@v3
with:
token: ${{ secrets.V2DOCS_TOKEN }}
repository: gui-cs/Terminal.GuiV1Docs
event-type: v2_develop_push
event-type: v1_release_push
client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
31 changes: 7 additions & 24 deletions GitVersion.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This file configures GitVersion 6.x to work with Terminal.Gui's GitFlow branching strategy.
# V1 0 This file configures GitVersion 6.x to work with Terminal.Gui's GitFlow branching strategy.
#
# Terminal.Gui uses the GitFlow branching strategy.
# Terminal.Gui v1 uses the GitFlow branching strategy.
# https://gitversion.net/docs/learn/branching-strategies/gitflow/
#
# - We have two main branches: `v1_release` and `v1_develop`.
Expand All @@ -16,9 +16,9 @@
# - v1_develop: Develop branch for V1 (historical)
#
# Package Naming:
# - from v1_develop: 2.1.0-develop.1 (minor version increments)
# - from v1_release (pre-release): 2.0.0-prealpha.1 or 2.0.0-beta.1
# - from v1_release (release): 2.0.0 (patch version increments)
# - from v1_develop: 1.1.0-develop.1 (minor version increments)
# - from v1_release (pre-release): 1.0.0-prealpha.1 or 1.0.0-beta.1
# - from v1_release (release): 1.0.0 (patch version increments)
#
mode: ContinuousDelivery # GitVersion 6.x uses Mainline mode for GitFlow, focusing on main branch releases

Expand All @@ -27,17 +27,16 @@ tag-prefix: '[vV]'

branches:

# V2 Release Branch
# V1 Release Branch
main:
# Matches the v1_release branch
regex: ^v1_release$
# Increments patch version (x.y.z+1) on commits
increment: Patch
# Specifies v1_develop as the source branch
source-branches: ['develop']
pre-release-weight: 100

# V2 Development Branch
# V1 Development Branch
develop:
# Matches the v1_develop branch
regex: v1_develop
Expand All @@ -50,22 +49,6 @@ branches:
# Indicates this branch feeds into release branches
tracks-release-branches: true

# # V1 Branches - Included for historical reference
# v1_develop:
# regex: v1_develop
# label: v1_develop
# increment: Minor
# source-branches: ['v1_release']
# # Lower weight keeps V1 pre-releases sorted below V2
# pre-release-weight: 100

# v1_release:
# regex: v1_release
# # Empty label for stable releases
# label: ''
# increment: Patch
# source-branches: ['v1_develop']

# Pull Request Branches
# Configures versioning for PRs (e.g., 2.0.0-pr.feature-123.1)
pull-request:
Expand Down
131 changes: 131 additions & 0 deletions Scripts/Terminal.Gui.PowerShell.Build.psd1
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
@{

# No root module because this is a manifest module.
RootModule = ''

# Version number of this module.
ModuleVersion = '1.0.0'

# Supported PSEditions
CompatiblePSEditions = @('Core')

# ID used to uniquely identify this module
GUID = 'c4a1de77-83fb-45a3-b1b5-18d275ef3601'

# Author of this module
Author = 'Brandon Thetford (GitHub @dodexahedron)'

# Company or vendor of this module
CompanyName = 'The Terminal.Gui Project'

# Copyright statement for this module
Copyright = 'Brandon Thetford (GitHub @dodexahedron), provided to the Terminal.Gui project and you under the MIT license'

# Description of the functionality provided by this module
Description = 'Build helper functions for Terminal.Gui.'

# Minimum version of the PowerShell engine required by this module
PowerShellVersion = '7.4.0'

# Name of the PowerShell "host" subsystem (not system host name). Helps ensure that we know what to expect from the environment.
PowerShellHostName = 'ConsoleHost'

# Minimum version of the PowerShell host required by this module
PowerShellHostVersion = '7.4.0'

# Processor architecture (None, MSIL, X86, IA64, Amd64, Arm, or an empty string) required by this module. One value only.
# Set to AMD64 here because development on Terminal.Gui isn't really supported on anything else.
# Has nothing to do with runtime use of Terminal.Gui.
ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
RequiredModules = @(
@{
ModuleName='Microsoft.PowerShell.Utility'
ModuleVersion='7.0.0'
},
@{
ModuleName='Microsoft.PowerShell.Management'
ModuleVersion='7.0.0'
},
@{
ModuleName='PSReadLine'
ModuleVersion='2.3.4'
},
"./Terminal.Gui.PowerShell.Core.psd1"
)

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules.
NestedModules = @('./Terminal.Gui.PowerShell.Build.psm1')

# Functions to export from this module.
FunctionsToExport = @('Build-TerminalGui')

# Cmdlets to export from this module.
CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = @()

# Aliases to export from this module.
AliasesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

PSData = @{

# Tags applied to this module. These help with module discovery in online galleries.
# Tags = @()

# A URL to the license for this module.
LicenseUri = 'https://github.com/gui-cs/Terminal.Gui/tree/v2_develop/Scripts/COPYRIGHT'

# A URL to the main website for this project.
ProjectUri = 'https://github.com/gui-cs/Terminal.Gui'

# A URL to an icon representing this module.
# IconUri = ''

# ReleaseNotes of this module
ReleaseNotes = 'See change history and releases for Terminal.Gui on GitHub'

# Prerelease string of this module
# Prerelease = ''

# Flag to indicate whether the module requires explicit user acceptance for install/update/save
RequireLicenseAcceptance = $false

# External dependent modules of this module
# ExternalModuleDependencies = @()

} # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

32 changes: 32 additions & 0 deletions Scripts/Terminal.Gui.PowerShell.Build.psm1
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<#
.SYNOPSIS
Builds the Terminal.Gui library.
.DESCRIPTION
Builds the Terminal.Gui library.
Optional parameter sets are available to customize the build.
.PARAMETER versionBase
The base version for the Terminal.Gui library.
#>
Function Build-TerminalGui {
[CmdletBinding(SupportsShouldProcess, PositionalBinding=$false, DefaultParameterSetName="Basic", ConfirmImpact="Medium")]
[OutputType([bool],[PSObject])]
param(
[Parameter(Mandatory=$true)]
[Version]$versionBase,
[Parameter(Mandatory=$true, ParameterSetName="Custom")]
[switch]$Custom,
[Parameter(Mandatory=$false, ParameterSetName="Custom")]
[ValidateSet("Debug", "Release")]
[string]$slnBuildConfiguration = "Release",
[Parameter(Mandatory=$false, ParameterSetName="Custom")]
[ValidateSet("Any CPU", "x86"<#, "x64" #>)]
[string]$slnBuildPlatform = "Any CPU"
)

if(!$PSCmdlet.ShouldProcess("Building in $slnBuildConfiguration configuration for $slnBuildPlatform", "Terminal.Gui", "BUILDING")) {
return $null
}

Write-Host NOT IMPLEMENTED. No Action has been taken.
return $false
}
138 changes: 138 additions & 0 deletions Scripts/Terminal.Gui.PowerShell.Core.psd1
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
#
# Module manifest for module 'Terminal.Gui.PowerShell'
#
# Generated by: Brandon Thetford (GitHub @dodexahedron)
#
# Generated on: 4/19/2024
#

@{

# No root module because this is a manifest module.
RootModule = ''

# Version number of this module.
ModuleVersion = '1.0.0'

# Supported PSEditions
CompatiblePSEditions = @('Core')

# ID used to uniquely identify this module
GUID = 'c661fb12-70ae-4a9e-a95c-786a7980681d'

# Author of this module
Author = 'Brandon Thetford (GitHub @dodexahedron)'

# Company or vendor of this module
CompanyName = 'The Terminal.Gui Project'

# Copyright statement for this module
Copyright = 'Brandon Thetford (GitHub @dodexahedron), provided to the Terminal.Gui project and you under the MIT license'

# Description of the functionality provided by this module
Description = 'Utilities for development-time operations on and management of components of Terminal.Gui code and other assets.'

# Minimum version of the PowerShell engine required by this module
PowerShellVersion = '7.4.0'

# Name of the PowerShell "host" subsystem (not system host name). Helps ensure that we know what to expect from the environment.
PowerShellHostName = 'ConsoleHost'

# Minimum version of the PowerShell host required by this module
PowerShellHostVersion = '7.4.0'

# Processor architecture (None, MSIL, X86, IA64, Amd64, Arm, or an empty string) required by this module. One value only.
# Set to AMD64 here because development on Terminal.Gui isn't really supported on anything else.
# Has nothing to do with runtime use of Terminal.Gui.
ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
RequiredModules = @(
@{
ModuleName='Microsoft.PowerShell.Utility'
ModuleVersion='7.0.0'
},
@{
ModuleName='Microsoft.PowerShell.Management'
ModuleVersion='7.0.0'
},
@{
ModuleName='PSReadLine'
ModuleVersion='2.3.4'
}
)

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
NestedModules = @('./Terminal.Gui.PowerShell.Core.psm1')

# Functions to export from this module.
FunctionsToExport = @('Open-Solution','Close-Solution')

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = @()

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

PSData = @{

# Tags applied to this module. These help with module discovery in online galleries.
# Tags = @()

# A URL to the license for this module.
LicenseUri = 'https://github.com/gui-cs/Terminal.Gui/tree/v2_develop/Scripts/COPYRIGHT'

# A URL to the main website for this project.
ProjectUri = 'https://github.com/gui-cs/Terminal.Gui'

# A URL to an icon representing this module.
# IconUri = ''

# ReleaseNotes of this module
ReleaseNotes = 'See change history and releases for Terminal.Gui on GitHub'

# Prerelease string of this module
# Prerelease = ''

# Flag to indicate whether the module requires explicit user acceptance for install/update/save
RequireLicenseAcceptance = $false

# External dependent modules of this module
# ExternalModuleDependencies = @()

} # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

Loading
Loading