-
Notifications
You must be signed in to change notification settings - Fork 181
Move admin center / publish to env authentication to action rather than inline powershell #2116
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
Open
aholstrup1
wants to merge
14
commits into
main
Choose a base branch
from
aholstrup/inlinepowershell
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
269dcb3
Remove inline powershell for getting credentials
aholstrup1 f2ca058
releasenotes
aholstrup1 7ffeab2
Merge branch 'main' of https://github.com/microsoft/AL-Go into aholst…
aholstrup1 5a419cf
Merge branch 'main' of https://github.com/microsoft/AL-Go into aholst…
aholstrup1 59656ff
Remove output log
aholstrup1 57b2b47
Update tests
aholstrup1 ce0f02b
Implement feedback
aholstrup1 ecef88e
Feedback
aholstrup1 e898b55
more test coverage
aholstrup1 c719448
Merge branch 'main' of https://github.com/microsoft/AL-Go into aholst…
aholstrup1 c1ca386
Cleanup
aholstrup1 14cb3ea
Merge branch 'main' into aholstrup/inlinepowershell
aholstrup1 38f7148
authType parameter
aholstrup1 f4da1e9
Merge branch 'main' into aholstrup/inlinepowershell
aholstrup1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| Param( | ||
| [Parameter(HelpMessage = "Name of the secret to check (e.g., 'adminCenterApiCredentials' or comma-separated list to check multiple)", Mandatory = $true)] | ||
| [string] $secretName, | ||
| [Parameter(HelpMessage = "Type of authentication (e.g., 'AuthContext' or 'Admin Center Api Credentials')", Mandatory = $false)] | ||
| [string] $authType = 'AuthContext', | ||
| [Parameter(HelpMessage = "Environment name (for error messages)", Mandatory = $false)] | ||
| [string] $environmentName = '' | ||
| ) | ||
|
|
||
| . (Join-Path -Path $PSScriptRoot -ChildPath "..\AL-Go-Helper.ps1" -Resolve) | ||
|
|
||
| $secrets = $env:Secrets | ConvertFrom-Json | ConvertTo-HashTable | ||
|
|
||
| # Check each secret name in order | ||
| $authContext = $null | ||
| $foundSecretName = '' | ||
| foreach ($name in ($secretName -split ',')) { | ||
| $name = $name.Trim() | ||
| if ($secrets.ContainsKey($name) -and $secrets."$name") { | ||
| Write-Host "Using $name secret" | ||
| $authContext = $secrets."$name" | ||
| $foundSecretName = $name | ||
| break | ||
| } | ||
| } | ||
|
|
||
| if ($authContext) { | ||
| Write-Host "$authType provided in secret $foundSecretName! Using this information for authentication." | ||
| } else { | ||
| Write-Host "No $authType provided, initiating Device Code flow" | ||
| DownloadAndImportBcContainerHelper | ||
| $authContext = New-BcAuthContext -includeDeviceLogin -deviceLoginTimeout ([TimeSpan]::FromSeconds(0)) | ||
| if ($null -eq $authContext) { | ||
| OutputError "Failed to acquire authentication context via device code flow." | ||
| return | ||
| } | ||
|
|
||
| # Build appropriate error message | ||
| if ($environmentName) { | ||
| $message = "AL-Go needs access to the Business Central Environment $($environmentName.Split(' ')[0]) and could not locate a secret called $($secretName -replace ',', ' or ')" | ||
| } | ||
| else { | ||
| $message = "AL-Go needs access to the Business Central Admin Center Api and could not locate a secret called $($secretName -replace ',', ' or ') (https://aka.ms/ALGoSettings#AdminCenterApiCredentialsSecretName)" | ||
| } | ||
|
|
||
| Add-Content -Encoding UTF8 -Path $ENV:GITHUB_STEP_SUMMARY -Value "$message`n`n$($authContext.message)" | ||
| Add-Content -Encoding UTF8 -Path $env:GITHUB_OUTPUT -Value "deviceCode=$($authContext.deviceCode)" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Check Auth Context | ||
|
|
||
| Check if Admin Center Api Credentials / AuthContext are provided in secrets. If not, initiate device code flow for authentication. | ||
|
|
||
| ## INPUT | ||
|
|
||
| ### ENV variables | ||
|
|
||
| | Name | Description | | ||
| | :-- | :-- | | ||
| | Settings | env.Settings must be set by a prior call to the ReadSettings Action | | ||
| | Secrets | env.Secrets must be set to the secrets output from ReadSecrets Action | | ||
|
|
||
| ### Parameters | ||
|
|
||
| | Name | Required | Description | Default value | | ||
| | :-- | :-: | :-- | :-- | | ||
| | shell | | The shell (powershell or pwsh) in which the PowerShell script in this action should run | powershell | | ||
| | secretName | Yes | Name of the secret to check (comma-separated list to check multiple in order) | | | ||
| | authType | | Type of authentication (e.g., 'AuthContext' or 'Admin Center Api Credentials') | AuthContext | | ||
| | environmentName | | Environment name (for error messages when deploying to environments) | | | ||
|
|
||
| ## OUTPUT | ||
|
|
||
| ### ENV variables | ||
|
|
||
| none | ||
|
|
||
| ### OUTPUT variables | ||
|
|
||
| | Name | Description | | ||
| | :-- | :-- | | ||
| | deviceCode | Device code for authentication (only set if device login is required) | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| name: Check Auth Context | ||
| author: Microsoft Corporation | ||
| inputs: | ||
| shell: | ||
| description: Shell in which you want to run the action (powershell or pwsh) | ||
| required: false | ||
| default: powershell | ||
| secretName: | ||
| description: Name of the secret to check (e.g., 'adminCenterApiCredentials' or comma-separated list to check multiple) | ||
| required: true | ||
| authType: | ||
| description: Type of authentication (e.g., 'AuthContext' or 'Admin Center Api Credentials') | ||
| required: false | ||
| default: 'AuthContext' | ||
| environmentName: | ||
| description: Environment name (for error messages) | ||
| required: false | ||
| default: '' | ||
| outputs: | ||
| deviceCode: | ||
| description: Device code for authentication (if device login is required) | ||
| value: ${{ steps.CheckAuthContext.outputs.deviceCode }} | ||
| runs: | ||
| using: composite | ||
| steps: | ||
| - name: run | ||
| shell: ${{ inputs.shell }} | ||
| id: CheckAuthContext | ||
| env: | ||
| _secretName: ${{ inputs.secretName }} | ||
| _authType: ${{ inputs.authType }} | ||
| _environmentName: ${{ inputs.environmentName }} | ||
| run: | | ||
| ${{ github.action_path }}/../Invoke-AlGoAction.ps1 -ActionName "CheckAuthContext" -Action { | ||
| ${{ github.action_path }}/CheckAuthContext.ps1 -secretName $ENV:_secretName -authType $ENV:_authType -environmentName $ENV:_environmentName | ||
| } | ||
| branding: | ||
| icon: terminal | ||
| color: blue |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A new version of AL-Go (v8.3) has been released.
Please move your release notes changes to above the
## v8.3section in the RELEASENOTES.md file.This ensures your changes are included in the next release rather than being listed under an already-released version.