Dockerize 202411 #4

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.

Sign up for GitHub

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

Jump to bottom

Open

markz0r wants to merge 14 commits into main from dockerize-202411

Member

markz0r commented Jun 23, 2025

This pull request introduces several updates to the AtlassianPowerKit module, including enhancements to Confluence page export functionality, the addition of new functions, and structural improvements. Key changes include the addition of a new submodule, updates to module manifests, and improvements to error handling and functionality in Confluence-related scripts.

Submodule Addition:

Added a new submodule htmltoadf to .gitmodules for handling HTML to Atlassian Document Format (ADF) conversions.

Module Manifest Updates:

Created a new manifest file AtlassianPowerKit-Admin.psd1 for the AtlassianPowerKit module, detailing module metadata, exported functions, and dependencies.

Confluence Functionality Enhancements:

Added Export-ConfluencePageToMarkDown function to export Confluence pages to Markdown format (currently a placeholder).
Introduced Set-AttachmentForConfluencePage function to upload attachments to Confluence pages.
Updated Export-ConfluencePage to support multiple formats (atlas_doc_format, storage) and improved file naming and return structure.
Changed default DepthLimit for recursive Confluence page export functions to 10 for better usability. [1] [2]

Error Handling Improvements:

Standardized try-catch blocks across multiple functions, ensuring consistent error logging and debugging output. [1] [2] [3] [4] [5] [6] [7] [8]

Function Renaming:

Renamed Set-ConfluencePageContent to Set-AttachmentForConfluencePage in the AtlassianPowerKit-Confluence.psd1 manifest for clarity.

markz0r and others added 14 commits

November 11, 2024 19:39


          prepping docker runner

783b501


          adding standardised Get-PaginatedJSONResults

dc53ca6


          adding standardised Get-PaginatedJSONResults

1cc477c


          synching updates

8067d37


          removed test files

56dff21


          synch

117287e


          Added htmltoadf as a submodule

4904a48


          sync

cebae29


          pre-docker final - tested

63876d4


          removing Microsoft vault dependency for 1password - untested

b5dc2a3


          Merge branch 'main' into dockerize-202411

89c0b22


          simplifying to config / envars

3d6d3b8


          Merge branch 'dockerize-202411' of github.com:OrganisationServiceMana…

928ff1c

…gement/AtlassianPowerKit into dockerize-202411


          Merge branch 'main' into dockerize-202411

1eadb5f

github-advanced-security bot found potential problems

View reviewed changes

AtlassianPowerKit-Shared/AtlassianPowerKit-Shared.psm1

    
                  $vaultPath = if ($env:OSMAtlassianProfilesVaultPath) {

                      $env:OSMAtlassianProfilesVaultPath

              # Function to set the Atlassian Cloud API headers

              function {

Check failure

Code scanning / PSScriptAnalyzer

Missing name after function keyword. Error

Missing name after function keyword.

AtlassianPowerKit-Shared/AtlassianPowerKit-Shared.psm1

    
                  }

              }

              # Consolidated Set-AtlassianPowerKitProfile function

              function Set-AtlassianPowerKitProfile {

Check warning

Code scanning / PSScriptAnalyzer

Function 'Set-AtlassianPowerKitProfile' has verb that could change system state. Therefore, the function has to support 'ShouldProcess'. Warning

Function 'Set-AtlassianPowerKitProfile' has verb that could change system state. Therefore, the function has to support 'ShouldProcess'.

AtlassianPowerKit-Shared/AtlassianPowerKit-Shared.psm1

    
                      [Parameter(Mandatory = $false)]

                      [string]$OSMProfileName,

                      [Parameter(Mandatory = $false)]

                      [switch]$Vault = $false

Check warning

Code scanning / PSScriptAnalyzer

The parameter 'Vault' has been declared but not used. Warning

The parameter 'Vault' has been declared but not used.

AtlassianPowerKit-Shared/AtlassianPowerKit-Shared.psm1

    
                      $OSMUsername = Read-Host 'Enter Atlassian Username (email)'

                      $OSMUsername = $OSMUsername.Trim().ToLower()

                      $env:AtlassianPowerKit_AtlassianAPIUserName = $OSMUsername

                  }

Check warning

Code scanning / PSScriptAnalyzer

Function 'Set-AtlassianAPIHeaders' has verb that could change system state. Therefore, the function has to support 'ShouldProcess'. Warning

Function 'Set-AtlassianAPIHeaders' has verb that could change system state. Therefore, the function has to support 'ShouldProcess'.

AtlassianPowerKit-Shared/AtlassianPowerKit-Shared.psm1

    
              }

              function Get-LevenshteinDistance {

              function New-AtlassianPowerKitProfile {

Check warning

Code scanning / PSScriptAnalyzer

Function 'New-AtlassianPowerKitProfile' has verb that could change system state. Therefore, the function has to support 'ShouldProcess'. Warning

Function 'New-AtlassianPowerKitProfile' has verb that could change system state. Therefore, the function has to support 'ShouldProcess'.

AtlassianPowerKit-Shared/AtlassianPowerKit-Shared.psm1

    
                          #Write-Debug "Found required environment variable: $envVarNameKey already set."

                          $ENV_STATE = $null

                          & op item create --category 'Secure Note' --vault $1PASSWORD_VAULT --title $1PASSWORD_TITLE $1PASSWORD_FIELD="$(Get-Content $tempPath -Raw)" | Write-Debug

                          Write-Host "`n✅ Created new 1Password item '$opEntry'."

Check warning

Code scanning / PSScriptAnalyzer

File 'AtlassianPowerKit-Shared.psm1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. Warning

File 'AtlassianPowerKit-Shared.psm1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information.

AtlassianPowerKit-Shared/AtlassianPowerKit-Shared.psm1

    
                  }

                  Return $true

              }

              function Remove-AtlassianPowerKitProfile {

Check warning

Code scanning / PSScriptAnalyzer

Function 'Remove-AtlassianPowerKitProfile' has verb that could change system state. Therefore, the function has to support 'ShouldProcess'. Warning

Function 'Remove-AtlassianPowerKitProfile' has verb that could change system state. Therefore, the function has to support 'ShouldProcess'.

AtlassianPowerKit-Shared/AtlassianPowerKit-Shared.psm1

    
              }

              function Remove-AtlassianPowerKitProfile {

                  param (

                      [Parameter(Mandatory = $true)]

Check failure

Code scanning / PSScriptAnalyzer

Parameter declarations are a comma-separated list of variable names with optional initializer expressions. Error

Parameter declarations are a comma-separated list of variable names with optional initializer expressions.

AtlassianPowerKit-Shared/AtlassianPowerKit-Shared.psm1

    
              }

              function Remove-AtlassianPowerKitProfile {

                  param (

                      [Parameter(Mandatory = $true)]

Check failure

Code scanning / PSScriptAnalyzer

Missing ')' in function parameter list. Error

Missing ')' in function parameter list.

AtlassianPowerKit-Shared/AtlassianPowerKit-Shared.psm1

    
              }

              function Remove-AtlassianPowerKitProfile {

                  param (

                      [Parameter(Mandatory = $true)]

Check warning

Code scanning / PSScriptAnalyzer

The parameter 'error' has been declared but not used. Warning

The parameter '__error__' has been declared but not used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet