From c41bb4b38811c68edfac5cfdd927c1ebe95ad5b2 Mon Sep 17 00:00:00 2001 From: Steve Fenton <99181436+steve-fenton-octopus@users.noreply.github.com> Date: Mon, 6 Nov 2023 14:43:16 +0000 Subject: [PATCH] Spellings --- dictionary-octopus.txt | 73 +++++++++++++++++++ .../docs/deployments/custom-scripts/index.md | 8 +- .../logging-messages-in-scripts.md | 12 +-- .../passing-parameters-to-scripts.md | 10 +-- .../using-variables-in-scripts.md | 2 +- .../linux/ssh-requirements.md | 2 +- .../deploy-release-step/index.md | 2 +- .../projects/deployment-process/artifacts.mdx | 2 +- .../projects/variables/output-variables.md | 18 ++--- ...space-with-environments-scripts.include.md | 10 +-- .../add-azure-web-app-scripts.include.md | 12 +-- ...uread-identity-to-users-scripts.include.md | 18 ++--- ...add-environment-to-step-scripts.include.md | 8 +- ...add-environment-to-team-scripts.include.md | 6 +- .../add-environments-scripts.include.md | 8 +- ...-library-set-to-project-scripts.include.md | 6 +- ...-script-step-to-runbook-scripts.include.md | 2 +- .../add-target-role-scripts.include.md | 10 +-- ...update-project-variable-scripts.include.md | 6 +- .../bulk-add-tenants-to-projects.include.md | 6 +- ...ncel-queued-deployments-scripts.include.md | 8 +- .../scripts/change-feed-scripts.include.md | 8 +- ...e-machine-machinepolicy-scripts.include.md | 8 +- ...k-for-tentacle-upgrades-scripts.include.md | 8 +- ...ear-sensitive-variables-scripts.include.md | 18 ++--- .../create-a-lifecycle-scripts.include.md | 4 +- .../create-a-tenant-scripts.include.md | 8 +- ...eate-and-deploy-release-scripts.include.md | 8 +- ...oy-release-with-tenants-scripts.include.md | 8 +- ...ate-and-publish-runbook-scripts.include.md | 2 +- .../scripts/create-api-key-scripts.include.md | 6 +- .../create-aws-account-scripts.include.md | 10 +-- ...azure-service-principal-scripts.include.md | 8 +- .../create-certificate-scripts.include.md | 14 ++-- .../scripts/create-channel-scripts.include.md | 4 +- ...te-google-cloud-account-scripts.include.md | 18 ++--- .../create-nuget-feed-scripts.include.md | 8 +- .../scripts/create-project-scripts.include.md | 8 +- .../create-projectgroup-scripts.include.md | 2 +- ...te-release-with-version-scripts.include.md | 6 +- .../scripts/create-runbook-scripts.include.md | 8 +- ...heduled-runbook-trigger-scripts.include.md | 8 +- .../create-script-step-scripts.include.md | 10 +-- .../scripts/create-tagset-scripts.include.md | 6 +- .../scripts/delete-a-space-scripts.include.md | 8 +- .../scripts/delete-feed-scripts.include.md | 8 +- .../delete-project-by-name-scripts.include.md | 8 +- ...delete-project-releases-scripts.include.md | 10 +-- ...jects-without-processes-scripts.include.md | 4 +- .../delete-targets-by-name-scripts.include.md | 8 +- .../delete-targets-by-role-scripts.include.md | 8 +- .../scripts/deploy-release-scripts.include.md | 10 +-- ...with-prompted-variables-scripts.include.md | 6 +- ...isable-project-triggers-scripts.include.md | 8 +- ...rtifact-from-deployment-scripts.include.md | 2 +- ...d-artifact-from-runbook-scripts.include.md | 4 +- .../download-package-scripts.include.md | 12 +-- .../enable-disable-machine-scripts.include.md | 8 +- .../environment-permissions-report.include.md | 10 +-- .../find-events-by-date-scripts.include.md | 2 +- ...ects-using-variable-set-scripts.include.md | 14 ++-- .../find-target-usage-no-tenants.include.md | 24 +++--- .../find-teams-with-role-scripts.include.md | 10 +-- .../scripts/find-unused-projects.include.md | 4 +- .../scripts/find-unused-targets.include.md | 4 +- .../find-variable-usage-scripts.include.md | 36 ++++----- ...nd-variable-value-usage-scripts.include.md | 10 +-- ...ableset-variables-usage-scripts.include.md | 36 ++++----- .../scripts/get-feeds-scripts.include.md | 8 +- ...get-steps-using-package-scripts.include.md | 4 +- .../get-steps-using-role-scripts.include.md | 12 +-- .../scripts/list-users-scripts.include.md | 6 +- ...sers-with-editing-roles-scripts.include.md | 8 +- ...ote-releases-not-in-destination.include.md | 4 +- .../publish-runbook-scripts.include.md | 14 ++-- .../scripts/push-package-scripts.include.md | 8 +- ...ster-listening-tentacle-scripts.include.md | 10 +-- ...gister-polling-tentacle-scripts.include.md | 13 ++-- ...emove-project-from-team-scripts.include.md | 8 +- .../replace-certificate-scripts.include.md | 10 +-- ...runbook-with-prompted-variables.include.md | 4 +- .../run-healthcheck-scripts.include.md | 14 ++-- .../scripts/run-runbook-scripts.include.md | 8 +- ...lease-variable-snapshot-scripts.include.md | 6 +- .../update-tenant-variable-scripts.include.md | 16 ++-- ...able-set-variable-value-scripts.include.md | 6 +- .../upgrade-machines-scripts.include.md | 8 +- 87 files changed, 456 insertions(+), 382 deletions(-) diff --git a/dictionary-octopus.txt b/dictionary-octopus.txt index cbefc25519..efa01c60a2 100644 --- a/dictionary-octopus.txt +++ b/dictionary-octopus.txt @@ -1,39 +1,74 @@ +actionid apikey +apikeys +argparse astro bootstrap bootstrapped bootstrapper +bufio +COMPUTERNAME +createartifact +cryptodome cscfg cspkg +csvfile cutover datetime +dateutil deallocate deallocated deploymentprocess deploymentprocesses DONTVALIDATEPATH +echoerror +elif +environmentids +eprintfn Fargate +fieldnames +filedata FIPS +getenv +hasattr +Hashtable HKEY HKLM hotfix hotfixes HSTS +icontains +IGNORECASE +includesystem +ioutil +Itoa ITSM jwks kustomization kustomize +libraryset +librarysets +libraryvariablesets lifecycles +Linq +lstrip +machinepolicies +machinepolicy maxage +mozroots msiexec MTTR Netscaler nologs +noninteractive +notcontains NTLM nupkg +O_WRONLY Octo octobak Octopub +octopusartifact octopusdeploy octopusid octopuslabs @@ -45,27 +80,65 @@ OIDC onlylogs passout pkcs +printfn +printhighlight +Println +printverbose +printwait +printwarning PROGRAMFILES +projectgroup +projectgroups +projecttriggers +querystring +quickstart reprioritize reprovisioned reprovisioning RSASSA +rstrip Runbook runbook +runbookprocesses +runbookruns runbooks +runbooksnapshot +runbooksnapshots +runbooksnapshottemplate Schannel +scopeduserrole +scopeduserroles SIEM signingkeys +Sprintf sthumb +strconv +struct swaggerui systemprofile tabpanel +tagset +tagsets +Tasklogs Trivy +typeof +unmarshal upgradelog +upgrader +urllib +userrole +userroles +utcnow +variableset +Voltron WCAG webfonts WEBSVR WIXUI +woah workertools +writeheader +writerow xlarge xmark +xvzf diff --git a/src/pages/docs/deployments/custom-scripts/index.md b/src/pages/docs/deployments/custom-scripts/index.md index d29688e8ff..f0c1722570 100644 --- a/src/pages/docs/deployments/custom-scripts/index.md +++ b/src/pages/docs/deployments/custom-scripts/index.md @@ -66,13 +66,13 @@ The precise details depend on the context within which your script is running, h 4. Any artifacts published by your scripts are transferred back to the Octopus Server. 5. The temporary work directory is cleaned up. -### Working directories {#Customscripts-Workingdirectories} +### Working directories When Calamari executes your scripts, it does so within the context of a working directory. The working directory is a temporary location stored under the home folder you configure when setting up a deployment target or worker. If you're executing a script contained within a package, the package contents will be uncompressed and copied to this directory, but the working directory is the directory containing the script within it. After the script has finished executing, the working directory will be cleaned up. Learn about [copying the contents of the working directory](/docs/support/copy-working-directory). -### Security and permissions {#Customscripts-Securityandpermissions} +### Security and permissions When scripts are executed, it is in the context of the account that the Tentacle agent or SSH session is running as. Learn about [running Tentacle as a different user account](/docs/infrastructure/deployment-targets/tentacle/windows/running-tentacle-under-a-specific-user-account). @@ -88,7 +88,7 @@ For example, when Calamari invokes PowerShell.exe, it uses the `Unrestricted` ex Learn about [script integrity](/docs/security/script-integrity). -### Developing and testing scripts {#Customscripts-Testingscripts} +### Developing and testing scripts We recommend the following approaches for developing and testing your scripts, in order of preference: @@ -104,7 +104,7 @@ We recommend the following approaches for developing and testing your scripts, i 1. If you are using PowerShell, Octopus has built-in support for PowerShell debugging. Learn about [debugging PowerShell scripts on remote machines using Octopus](/docs/deployments/custom-scripts/debugging-powershell-scripts/debugging-powershell-scripts-on-remote-machines). 2. For all scripting languages, you can tell Octopus to preserve the script and its entire working directory so you can run it interactively. Learn about [copying the working directory](/docs/support/copy-working-directory). -### Scripts that block deployments {#Customscripts-Scriptsthatblockdeployments} +### Scripts that block deployments Sometimes a script launches a service or application that runs continuously. In this case the script does not complete until the application is terminated. When the script is run in an Octopus process, the Octopus task will continue executing until the script exits. In most cases this is undesirable. In order to avoid this behavior the service or application should be launched in a separate process or session, allowing the rest of the process to continue executing. For example: diff --git a/src/pages/docs/deployments/custom-scripts/logging-messages-in-scripts.md b/src/pages/docs/deployments/custom-scripts/logging-messages-in-scripts.md index 9d58399a09..aa8a88268d 100644 --- a/src/pages/docs/deployments/custom-scripts/logging-messages-in-scripts.md +++ b/src/pages/docs/deployments/custom-scripts/logging-messages-in-scripts.md @@ -96,7 +96,7 @@ Progress messages will display and update a progress bar on your deployment task
PowerShell -```ps PowerShell +```powershell Update-Progress 10 Update-Progress 50 "Woah, we're halfway there!" ``` @@ -133,8 +133,8 @@ Octopus.updateProgress 50 "Woah, we're halfway there!" Python3 ```python -updateprogress(10) -updateprogress(50, 'Woah, we\'re halfway there!') +update_progress(10) +update_progress(50, 'Woah, we\'re halfway there!') ```
@@ -176,7 +176,7 @@ let updateProgress (percentage: int) message = def encode(value): return base64.b64encode(value.encode('utf-8')).decode('utf-8') -def updateprogress(progress, message=None): +def update_progress(progress, message=None): encodedProgress = encode(str(progress)) encodedMessage = encode(message) @@ -188,12 +188,12 @@ def updateprogress(progress, message=None): Bash ```bash -function encode_servicemessagevalue +function encode_service_message_value { echo -n "$1" | openssl enc -base64 -A } -echo "##octopus[progress percentage='$(encode_servicemessagevalue "$1")' message='$(encode_servicemessagevalue "$2")']" +echo "##octopus[progress percentage='$(encode_service_message_value "$1")' message='$(encode_service_message_value "$2")']" ``` diff --git a/src/pages/docs/deployments/custom-scripts/passing-parameters-to-scripts.md b/src/pages/docs/deployments/custom-scripts/passing-parameters-to-scripts.md index 69264717fb..807cca66ce 100644 --- a/src/pages/docs/deployments/custom-scripts/passing-parameters-to-scripts.md +++ b/src/pages/docs/deployments/custom-scripts/passing-parameters-to-scripts.md @@ -43,7 +43,7 @@ You can define your parameters in the **Script Parameters** field using the form Don't forget to correctly delimit your parameters correctly for the scripting engine. In the example above we have surrounded the parameter value in double-quotes to handle cases where the Environment Name has spaces: `"#{Octopus.Environment.Name}"` ::: -## Passing parameters to PowerShell scripts {#Customscripts-PassingparameterstoPowerShellscripts} +## Passing parameters to PowerShell scripts You can pass parameters to PowerShell scripts as if you were calling the script yourself from PowerShell, using positional or named parameters. @@ -66,7 +66,7 @@ Param ( Write-Host "$Environment storage path: $StoragePath" ``` -## Passing parameters to C# scripts {#Customscripts-PassingparameterstoC#scripts} +## Passing parameters to C# scripts You can pass parameters to C# scripts [as described here for the dotnet-script engine](https://github.com/dotnet-script/dotnet-script#passing-arguments-to-scripts). @@ -84,7 +84,7 @@ var storagePath = Args[1] Console.WriteLine("{0} storage path: {1}", environment, storagePath); ``` -## Passing parameters to Bash scripts {#Customscripts-PassingparameterstoBashscripts} +## Passing parameters to Bash scripts You can pass parameters to Bash scripts [as described in Bash manual.](https://www.gnu.org/software/bash/manual/bash.html#Positional-Parameters) @@ -102,7 +102,7 @@ storagePath="$2" echo "$environment storage path: $storagePath" ``` -## Passing parameters to F# scripts {#Customscripts-PassingparameterstoF#scripts} +## Passing parameters to F# scripts You can pass parameters to FSharp scripts [as described by the F# documentation.](https://docs.microsoft.com/en-us/dotnet/fsharp/tools/fsharp-interactive/#using-the-fsi-object-in-f-code) @@ -120,7 +120,7 @@ let storagePath = fsi.CommandLineArgs.[2] printfn "$s storage path: $s" environment storagePath ``` -## Passing parameters to Python3 scripts {#Customscripts-Passingparameterstopythonscripts} +## Passing parameters to Python3 scripts You can pass parameters to python scripts [as described by the python documentation.](https://docs.python.org/3/tutorial/interpreter.html#argument-passing) diff --git a/src/pages/docs/deployments/custom-scripts/using-variables-in-scripts.md b/src/pages/docs/deployments/custom-scripts/using-variables-in-scripts.md index 0e2e231b29..7b67226199 100644 --- a/src/pages/docs/deployments/custom-scripts/using-variables-in-scripts.md +++ b/src/pages/docs/deployments/custom-scripts/using-variables-in-scripts.md @@ -84,7 +84,7 @@ print(connectionString) To see the F# API available to your F# scripts, take a look at our [F# signature file](https://github.com/OctopusDeploy/Calamari/tree/master/source/Calamari.Common/Features/Scripting/FSharp/Bootstrap.fsi). ::: -## Variables in PowerShell scripts {#Customscripts-VariablesinPowerShellscripts} +## Variables in PowerShell scripts In PowerShell we have pre-defined some script-scoped variables for you as a convenience. Consider the same example as before, a variable named "MyApp.ConnectionString" will be available as both: diff --git a/src/pages/docs/infrastructure/deployment-targets/linux/ssh-requirements.md b/src/pages/docs/infrastructure/deployment-targets/linux/ssh-requirements.md index 8133279903..f7e9318f70 100644 --- a/src/pages/docs/infrastructure/deployment-targets/linux/ssh-requirements.md +++ b/src/pages/docs/infrastructure/deployment-targets/linux/ssh-requirements.md @@ -35,7 +35,7 @@ Octopus can execute Python scripts on SSH targets provided the following criteri - Python is version 3.4+ - Python3 is on the path for the SSH user executing the deployment -- pip is installed or the pycryptodome python package is installed +- pip is installed or the PyCryptodome Python package is installed ## F# diff --git a/src/pages/docs/projects/coordinating-multiple-projects/deploy-release-step/index.md b/src/pages/docs/projects/coordinating-multiple-projects/deploy-release-step/index.md index 51621cd774..15bb1a2eaa 100644 --- a/src/pages/docs/projects/coordinating-multiple-projects/deploy-release-step/index.md +++ b/src/pages/docs/projects/coordinating-multiple-projects/deploy-release-step/index.md @@ -68,7 +68,7 @@ These output variables are captured as variables with the following name pattern Octopus.Action[Deploy Release Step Name].Output.Deployment[Child Step Name].VariableName ``` -and for [machine-specific output variables](/docs/projects/variables/output-variables/#Outputvariables-Outputfrommultiplemachines): +and for [machine-specific output variables](/docs/projects/variables/output-variables/#output-from-multiple-deployment-targets): ``` Octopus.Action[Deploy Release Step Name].Output.Deployment[Child Step Name][Machine Name].VariableName diff --git a/src/pages/docs/projects/deployment-process/artifacts.mdx b/src/pages/docs/projects/deployment-process/artifacts.mdx index 5e51d37171..f012486760 100644 --- a/src/pages/docs/projects/deployment-process/artifacts.mdx +++ b/src/pages/docs/projects/deployment-process/artifacts.mdx @@ -21,7 +21,7 @@ After the script runs the files will be uploaded to Octopus Server and made avai ![](/docs/projects/deployment-process/images/artifacts-access.png "width=500") ::: -## Collecting artifacts using scripts \{#Artifacts-Collectingartifactsusingscripts} +## Collecting artifacts using scripts You can collect artifacts using any of the scripting languages supported by Octopus. In each scripting language you can specify the path to the file you want to collect as an artifact as an absolute path, or a path relative to the current working directory. By default, the file name will be used as the artifact name, but you can provide a custom name for the artifact as an alternative. diff --git a/src/pages/docs/projects/variables/output-variables.md b/src/pages/docs/projects/variables/output-variables.md index 6664495341..c7a611eba0 100644 --- a/src/pages/docs/projects/variables/output-variables.md +++ b/src/pages/docs/projects/variables/output-variables.md @@ -146,7 +146,7 @@ set_octopusvariable("Password", "correct horse battery staple", True) -## System output variables {#Outputvariables-Systemoutputvariables} +## System output variables After a step runs, Octopus captures the output variables, and keeps them for use in subsequent steps. In addition to variables that you create yourself using `Set-OctopusVariable`, Octopus also makes a number of built-in variables available. Here are some examples of commonly used built-in output variables: @@ -159,7 +159,7 @@ After a step runs, Octopus captures the output variables, and keeps them for use - `Octopus.Action[StepName].Output.Manual.ResponsibleUser.DisplayName` - `Octopus.Action[StepName].Output.Manual.ResponsibleUser.EmailAddress` -## Output from multiple deployment targets {#Outputvariables-Outputfrommultiplemachines} +## Output from multiple deployment targets {#output-from-multiple-deployment-targets} Output variables become more complex when multiple deployment targets are involved, but they can still be used. @@ -180,24 +180,24 @@ Note that for each output variable/deployment target combination: - A variable is created with the deployment target name contained in the variable name: this allows you to reference output variables from set by one deployment target from another deployment target. - A variable is created that is [scoped](/docs/projects/variables/#scoping-variables) to the deployment target. This way Web01 will always get the value Web01 set, and Web02 will get the value Web02 set. -- A variable is created with no scope, and no differentiator in the name. When referencing this value, the result will be indeterministic, but it allows scripts to use the value without knowing which deployment target set it. +- A variable is created with no scope, and no differentiator in the name. When referencing this value, the result will be non-deterministic, but it allows scripts to use the value without knowing which deployment target set it. For some practical examples of using output variables, and how scoping rules are applied, see the following blog posts: - [Fun with output variables](https://octopus.com/blog/fun-with-output-variables) - [Changing website ports using output variables](http://octopus.com/blog/changing-website-port-on-each-deployment) -## Output from deploy a release steps {#Outputvariables-Outputfromdeployareleasesteps} +## Output from deploy a release steps Output variables from deployments triggered by a _Deploy a Release_ step are captured and exposed as output variables on the _Deploy a Release_ step. To get the value of an output variable from a _Deploy a Release_ step, use the `Output.Deployment` variable on the _Deploy a Release_ step. For example, if your _Deploy a Release_ step is named "Deploy Web Project", the target step in the child project is named "Update IP Address", and the variable name is "IPAddress", you would use the following variable to access it in the parent project: `Octopus.Action[Deploy Web Project].Output.Deployment[Update IP Address].IPAddress`. -## Setting output variables using scripts {#Outputvariables-Settingoutputvariablesusingscripts} +## Setting output variables using scripts You can set output variables using any of the scripting languages supported by Octopus. In each case we make special functions available to your scripts by bootstrapping them with a template defined in the [open-source Calamari project](https://github.com/OctopusDeploy/Calamari). -### PowerShell {#Outputvariables-PowerShell} +### PowerShell [PowerShell Bootstrapping](https://github.com/OctopusDeploy/Calamari/tree/master/source/Calamari.Common/Features/Scripting/WindowsPowerShell/) @@ -214,7 +214,7 @@ For example: Set-OctopusVariable -name "TestResult" -value "Passed" ``` -### C# {#Outputvariables-C#} +### C# [Dotnet Script Bootstrapping](https://github.com/OctopusDeploy/Calamari/tree/master/source/Calamari.Common/Features/Scripting/DotnetScript) @@ -226,7 +226,7 @@ From a C# script, you can use the `public static void SetVariable(string name, s SetVariable("TestResult", "Passed"); ``` -### Bash {#Outputvariables-Bash} +### Bash [Bash Bootstrapping](https://github.com/OctopusDeploy/Calamari/tree/master/source/Calamari.Common/Features/Scripting/Bash) @@ -238,7 +238,7 @@ In a Bash script you can use the `set_octopusvariable` function to set the name set_octopusvariable "TestResult" "Passed" ``` -### F# {#Outputvariables-F#} +### F# [FSharp Bootstrapping](https://github.com/OctopusDeploy/Calamari/tree/master/source/Calamari.Common/Features/Scripting/FSharp) diff --git a/src/shared-content/scripts/add-a-space-with-environments-scripts.include.md b/src/shared-content/scripts/add-a-space-with-environments-scripts.include.md index 41947a9cac..2cd5636972 100644 --- a/src/shared-content/scripts/add-a-space-with-environments-scripts.include.md +++ b/src/shared-content/scripts/add-a-space-with-environments-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "New Space" @@ -65,7 +65,7 @@ foreach ($environment in $environments) { Add-Type -Path 'path\to\Octopus.Client.dll' $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $endpoint = New-Object Octopus.Client.OctopusServerEndpoint($octopusURL, $octopusAPIKey) $repository = New-Object Octopus.Client.OctopusRepository($endpoint) @@ -123,7 +123,7 @@ using Octopus.Client; using Octopus.Client.Model; var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var endpoint = new OctopusServerEndpoint(octopusURL, octopusAPIKey); var repository = new OctopusRepository(endpoint); @@ -187,7 +187,7 @@ import requests # Define Octopus server variables octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} # Define working variables @@ -254,7 +254,7 @@ func main() { log.Println(err) } - APIKey := "API-YOURAPIKEY" + APIKey := "API-YOUR-KEY" spaceManagersTeamMembers := []string{} // This or spaceManagerTeams must contain a value spaceManagerTeams := []string{"teams-administrators"} // This or spaceManagersTeamMembers must contain a value, "teams-administrators" is the Octopus Administrators team environments := []string{"Development", "Test", "Production"} diff --git a/src/shared-content/scripts/add-azure-web-app-scripts.include.md b/src/shared-content/scripts/add-azure-web-app-scripts.include.md index 2a07666dbd..f49ae68e92 100644 --- a/src/shared-content/scripts/add-azure-web-app-scripts.include.md +++ b/src/shared-content/scripts/add-azure-web-app-scripts.include.md @@ -6,13 +6,13 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $azureServicePrincipalName = "MyAzureAccount" $azureResourceGroupName = "MyResourceGroup" $environmentNames = @("Development", "Production") -$roles = @("Myrole") +$roles = @("MyRole") $environmentIds = @() $azureWebAppName = "MyAzureWebAppName" @@ -56,7 +56,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $azureServicePrincipalName = "MyAzureAccount" $azureResourceGroupName = "MyResourceGroup" $azureWebAppName = "MyAzureWebApp" @@ -128,7 +128,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string[] environmentNames = { "Development", "Production" }; string[] roles = { "MyRole" }; @@ -199,7 +199,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} @@ -270,7 +270,7 @@ func main() { log.Println(err) } - APIKey := "API-YOURKEY" + APIKey := "API-YOUR-KEY" // Get space to work with space := GetSpace(apiURL, APIKey, spaceName) diff --git a/src/shared-content/scripts/add-azuread-identity-to-users-scripts.include.md b/src/shared-content/scripts/add-azuread-identity-to-users-scripts.include.md index f840b86615..9a803fc25c 100644 --- a/src/shared-content/scripts/add-azuread-identity-to-users-scripts.include.md +++ b/src/shared-content/scripts/add-azuread-identity-to-users-scripts.include.md @@ -1,4 +1,4 @@ -
+
PowerShell (REST API) ```powershell @@ -139,13 +139,13 @@ function AddAzureADLogins( $existingOctopusUser.Identities += $newAzureADIdentity } - # Update user's email address if set AND the value isnt empty. + # Update user's email address if set AND the value isn't empty. if($UpdateOctopusEmailAddress -eq $True -and -not([string]::IsNullOrWhiteSpace($User.AzureEmailAddress) -eq $true)) { Write-Debug "Setting Octopus email address to: $($User.AzureEmailAddress)" $existingOctopusUser.EmailAddress = $User.AzureEmailAddress } - # Update user's display name if set AND the value isnt empty. + # Update user's display name if set AND the value isn't empty. if($UpdateOctopusDisplayName -eq $True -and -not([string]::IsNullOrWhiteSpace($User.AzureDisplayName) -eq $true)) { Write-Debug "Setting Octopus display name to: $($User.AzureDisplayName)" $existingOctopusUser.DisplayName = $User.AzureDisplayName @@ -183,7 +183,7 @@ function AddAzureADLogins( ```
-
+
PowerShell (Octopus.Client) ```powershell @@ -329,14 +329,14 @@ function AddAzureLogins $existingOctopusUser.Identities += $newAzureADIdentity # Identities is an array } - # Update user's email address if set AND the value isnt empty. + # Update user's email address if set AND the value isn't empty. if($UpdateOctopusEmailAddress -eq $True -and -not([string]::IsNullOrWhiteSpace($User.AzureEmailAddress) -eq $true)) { Write-Debug "Setting Octopus email address to: $($User.AzureEmailAddress)" $existingOctopusUser.EmailAddress = $User.AzureEmailAddress } - # Update user's display name if set AND the value isnt empty. + # Update user's display name if set AND the value isn't empty. if($UpdateOctopusDisplayName -eq $True -and -not([string]::IsNullOrWhiteSpace($User.AzureDisplayName) -eq $true)) { Write-Debug "Setting Octopus display name to: $($User.AzureDisplayName)" @@ -372,7 +372,7 @@ function AddAzureLogins ```
-
+
C# ```csharp @@ -565,7 +565,7 @@ public static void AddAzureLogins(string OctopusUrl, string ApiKey, string Path ```
-
+
Python3 ```python @@ -706,7 +706,7 @@ AddAzureLogins(octopus_server_uri, octopus_api_key, OctopusUsername='some.email@ ```
-
+
Go ```go diff --git a/src/shared-content/scripts/add-environment-to-step-scripts.include.md b/src/shared-content/scripts/add-environment-to-step-scripts.include.md index b6d5cef187..5cd753d38f 100644 --- a/src/shared-content/scripts/add-environment-to-step-scripts.include.md +++ b/src/shared-content/scripts/add-environment-to-step-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $projectName = "MyProject" @@ -47,7 +47,7 @@ Invoke-RestMethod -Method Put -Uri "$octopusURL/api/$($space.Id)/deploymentproce ```powershell Add-Type -Path "path\to\Octopus.Client.dll" -$apikey = "API-YOURAPIKEY" +$apikey = "API-YOUR-KEY" $octopusURL = "https://youroctourl" $spaceName = "default" $stepName = "Run a script" @@ -105,7 +105,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string projectName = "MyProject"; string[] environmentNames = { "Development", "Test" }; @@ -166,7 +166,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} diff --git a/src/shared-content/scripts/add-environment-to-team-scripts.include.md b/src/shared-content/scripts/add-environment-to-team-scripts.include.md index 64a7bf1e07..3467fac5b1 100644 --- a/src/shared-content/scripts/add-environment-to-team-scripts.include.md +++ b/src/shared-content/scripts/add-environment-to-team-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $teamName = "MyTeam" @@ -49,7 +49,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $environmentNames = @("Test", "Production") $teamName = "MyTeam" @@ -105,7 +105,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string[] environmentNames = { "Development", "Production" }; string teamName = "MyTeam"; diff --git a/src/shared-content/scripts/add-environments-scripts.include.md b/src/shared-content/scripts/add-environments-scripts.include.md index 5b7d172c5e..38f074034a 100644 --- a/src/shared-content/scripts/add-environments-scripts.include.md +++ b/src/shared-content/scripts/add-environments-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctopus.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" @@ -50,7 +50,7 @@ $ErrorActionPreference = "Stop"; Add-Type -Path 'path\to\Octopus.Client.dll' $octopusURL = "https://youroctopus.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "Default" $environments = @("Development", "Test", "Staging", "Production") @@ -94,7 +94,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctopus.octopus.app"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "Default"; var environments = new List { "Development", "Staging", "Test", "Production" }; @@ -144,7 +144,7 @@ import requests from urllib.parse import quote octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): diff --git a/src/shared-content/scripts/add-library-set-to-project-scripts.include.md b/src/shared-content/scripts/add-library-set-to-project-scripts.include.md index b1659275c6..fee885eeeb 100644 --- a/src/shared-content/scripts/add-library-set-to-project-scripts.include.md +++ b/src/shared-content/scripts/add-library-set-to-project-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $projectName = "MyProject" $librarySetName = "MyLibrarySet" @@ -37,7 +37,7 @@ Add-Type -Path "c:\octopus.client\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $projectName = "MyProject" $librarySetName = "MyLibrarySet" @@ -82,7 +82,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string projectName = "MyProject"; string librarySetName = "MyLibrarySet"; diff --git a/src/shared-content/scripts/add-script-step-to-runbook-scripts.include.md b/src/shared-content/scripts/add-script-step-to-runbook-scripts.include.md index 5e3db9f66d..26df345e1f 100644 --- a/src/shared-content/scripts/add-script-step-to-runbook-scripts.include.md +++ b/src/shared-content/scripts/add-script-step-to-runbook-scripts.include.md @@ -10,7 +10,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "default"; var runbookName = "MyRunbook"; var stepName = "My new step"; diff --git a/src/shared-content/scripts/add-target-role-scripts.include.md b/src/shared-content/scripts/add-target-role-scripts.include.md index e66b6d73b3..575f39f397 100644 --- a/src/shared-content/scripts/add-target-role-scripts.include.md +++ b/src/shared-content/scripts/add-target-role-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $machineName = "MyMachine" @@ -34,7 +34,7 @@ Add-Type -Path "c:\octopus.client\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $machineName = "MyMachine" $targetRole = "MyRole" @@ -75,10 +75,10 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string machineName = "MyMachine"; -string roleName = "testrole"; +string roleName = "TestRole"; // Create repository object var endpoint = new OctopusServerEndpoint(octopusURL, octopusAPIKey); @@ -114,7 +114,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} diff --git a/src/shared-content/scripts/add-update-project-variable-scripts.include.md b/src/shared-content/scripts/add-update-project-variable-scripts.include.md index dfc5851c61..930b99921a 100644 --- a/src/shared-content/scripts/add-update-project-variable-scripts.include.md +++ b/src/shared-content/scripts/add-update-project-variable-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" $projectName = "MyProject" @@ -60,7 +60,7 @@ Add-Type -Path "c:\octopus.client\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $projectName = "MyProject" $variable = @{ @@ -127,7 +127,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string projectName = "MyProject"; System.Collections.Hashtable variable = new System.Collections.Hashtable() diff --git a/src/shared-content/scripts/bulk-add-tenants-to-projects.include.md b/src/shared-content/scripts/bulk-add-tenants-to-projects.include.md index 53d6b34d1f..188c1dc265 100644 --- a/src/shared-content/scripts/bulk-add-tenants-to-projects.include.md +++ b/src/shared-content/scripts/bulk-add-tenants-to-projects.include.md @@ -102,7 +102,7 @@ function Invoke-OctopusApi Write-OctopusVerbose "Ignoring cache." } - Write-OctopusVerbose "No data to post or put, calling bog standard invoke-restmethod for $url" + Write-OctopusVerbose "No data to post or put, calling bog standard Invoke-RestMethod for $url" $result = Invoke-RestMethod -Method $method -Uri $url -Headers @{"X-Octopus-ApiKey" = "$ApiKey" } -ContentType 'application/json; charset=utf-8' if ($cachedResults.ContainsKey($url) -eq $true) @@ -229,9 +229,9 @@ $spaceId = $space.Id $project = Get-OctopusItemByName -itemName $projectName -itemType "Project" -endpoint "projects" -spaceId $spaceId -defaultUrl $octopusUrl -octopusApiKey $octopusApiKey $projectId = $project.Id -$splitEnvironmentlist = $environmentNameList -split "," +$splitEnvironmentList = $environmentNameList -split "," $environmentList = @() -foreach ($environmentName in $splitEnvironmentlist) +foreach ($environmentName in $splitEnvironmentList) { $environment = Get-OctopusItemByName -itemName $environmentName -itemType "Environment" -endpoint "environments" -spaceId $spaceId -defaultUrl $octopusUrl -octopusApiKey $octopusApiKey $environmentList += $environment.Id diff --git a/src/shared-content/scripts/cancel-queued-deployments-scripts.include.md b/src/shared-content/scripts/cancel-queued-deployments-scripts.include.md index b0a516cf4e..e30642e025 100644 --- a/src/shared-content/scripts/cancel-queued-deployments-scripts.include.md +++ b/src/shared-content/scripts/cancel-queued-deployments-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" @@ -45,7 +45,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "http://octotemp"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; // Create repository object @@ -92,7 +92,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} @@ -152,7 +152,7 @@ func main() { if err != nil { log.Println(err) } - APIKey := "API-YOURAPIKEY" + APIKey := "API-YOUR-KEY" spaceName := "Default" // Get reference to space diff --git a/src/shared-content/scripts/change-feed-scripts.include.md b/src/shared-content/scripts/change-feed-scripts.include.md index fb70858d57..b66ef43bfa 100644 --- a/src/shared-content/scripts/change-feed-scripts.include.md +++ b/src/shared-content/scripts/change-feed-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $feedName = "nuget.org" @@ -36,7 +36,7 @@ Add-Type -Path "C:\Octo\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $feedName = "nuget.org" @@ -82,7 +82,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "Default"; string feedName = "nuget.org"; @@ -124,7 +124,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} space_name = "Default" diff --git a/src/shared-content/scripts/change-machine-machinepolicy-scripts.include.md b/src/shared-content/scripts/change-machine-machinepolicy-scripts.include.md index d452789549..9e2bd66eff 100644 --- a/src/shared-content/scripts/change-machine-machinepolicy-scripts.include.md +++ b/src/shared-content/scripts/change-machine-machinepolicy-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $machineName = "MyMachine" @@ -36,7 +36,7 @@ Add-Type -Path "c:\octopus.client\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $machineName = "MyMachine" $machinePolicyName = "MyPolicy" @@ -80,7 +80,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string machineName = "MyMachine"; string machinePolicyName = "TestPolicy"; @@ -122,7 +122,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} diff --git a/src/shared-content/scripts/check-for-tentacle-upgrades-scripts.include.md b/src/shared-content/scripts/check-for-tentacle-upgrades-scripts.include.md index 93232246b1..99ec5dcd4e 100644 --- a/src/shared-content/scripts/check-for-tentacle-upgrades-scripts.include.md +++ b/src/shared-content/scripts/check-for-tentacle-upgrades-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://your.octopus.app/api" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" @@ -44,7 +44,7 @@ $workers = Invoke-RestMethod -Method Get -Uri "$octopusSpaceUrl/workers/all" -He Add-Type -Path 'C:\path\to\Octopus.Client.dll' $octopusURL = "https://your.octopus.app/api" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "Default" $endpoint = New-Object Octopus.Client.OctopusServerEndpoint $octopusURL, $octopusAPIKey @@ -91,7 +91,7 @@ using Octopus.Client.Model; using Octopus.Client.Model.Endpoints; var octopusURL = "https://your.octopus.app"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var endpoint = new OctopusServerEndpoint(octopusURL, octopusAPIKey); var repository = new OctopusRepository(endpoint); @@ -148,7 +148,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} diff --git a/src/shared-content/scripts/clear-sensitive-variables-scripts.include.md b/src/shared-content/scripts/clear-sensitive-variables-scripts.include.md index 6b7584ee2f..910ce054b2 100644 --- a/src/shared-content/scripts/clear-sensitive-variables-scripts.include.md +++ b/src/shared-content/scripts/clear-sensitive-variables-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } Function Clear-SensitiveVariables @@ -80,7 +80,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $endpoint = New-Object Octopus.Client.OctopusServerEndpoint $octopusURL, $octopusAPIKey @@ -146,7 +146,7 @@ catch // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "default"; // Create repository object @@ -314,7 +314,7 @@ func main() { log.Println(err) } APIKey := "API-YourAPIKey" - spaceName := "MySace" + spaceName := "YourSpace" // Get reference to space space := GetSpace(apiURL, APIKey, spaceName) @@ -345,18 +345,18 @@ func main() { // Loop through sets for i := 0; i < len(librarySets); i++ { - librarysetVariables := GetVariables(apiURL, APIKey, space, librarySets[i].ID) + librarySetVariables := GetVariables(apiURL, APIKey, space, librarySets[i].ID) variablesUpdated := false - for j := 0; j < len(librarysetVariables.Variables); j++ { - if librarysetVariables.Variables[j].IsSensitive { - librarysetVariables.Variables[j].Value = "" + for j := 0; j < len(librarySetVariables.Variables); j++ { + if librarySetVariables.Variables[j].IsSensitive { + librarySetVariables.Variables[j].Value = "" variablesUpdated = true } } if variablesUpdated { println("Variables for " + librarySets[i].Name + " have been updated") - UpdateVariables(apiURL, APIKey, space, librarysetVariables.OwnerID, librarysetVariables) + UpdateVariables(apiURL, APIKey, space, librarySetVariables.OwnerID, librarySetVariables) } } } diff --git a/src/shared-content/scripts/create-a-lifecycle-scripts.include.md b/src/shared-content/scripts/create-a-lifecycle-scripts.include.md index d707cb3101..6707e889f5 100644 --- a/src/shared-content/scripts/create-a-lifecycle-scripts.include.md +++ b/src/shared-content/scripts/create-a-lifecycle-scripts.include.md @@ -37,7 +37,7 @@ function Get-OctopusItems # Store call results $items += $resultSet.Items - # Check to see if resultset is bigger than page amount + # Check to see if result set is bigger than page amount if (($resultSet.Items.Count -gt 0) -and ($resultSet.Items.Count -eq $resultSet.ItemsPerPage)) { # Increment skip count @@ -126,7 +126,7 @@ $repositoryForSpace = $client.ForSpace($space) # Check to see if lifecycle already exists if ($null -eq $repositoryForSpace.Lifecycles.FindByName($lifecycleName)) { - # Create new lifecyle + # Create new lifecycle $lifecycle = New-Object Octopus.Client.Model.LifecycleResource $lifecycle.Name = $lifecycleName $repositoryForSpace.Lifecycles.Create($lifecycle) diff --git a/src/shared-content/scripts/create-a-tenant-scripts.include.md b/src/shared-content/scripts/create-a-tenant-scripts.include.md index 4d3b2f4742..53ba14b1c7 100644 --- a/src/shared-content/scripts/create-a-tenant-scripts.include.md +++ b/src/shared-content/scripts/create-a-tenant-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } # Provide the space name $spaceName = "Default" @@ -89,7 +89,7 @@ try # Get projects $projects = $repositoryForSpace.Projects.GetAll() | Where-Object {$projectNames -contains $_.Name} - # Create projectenvironments + # Create project environments $projectEnvironments = New-Object Octopus.Client.Model.ReferenceCollection foreach ($environment in $environments) { @@ -134,7 +134,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string tenantName = "MyTenant"; string[] projectNames = { "MyProject" }; @@ -158,7 +158,7 @@ try // Get environments var environments = repositoryForSpace.Environments.FindByNames(environmentNames); - // Create projectenvironments + // Create project environments Octopus.Client.Model.ReferenceCollection projectEnvironments = new ReferenceCollection(); foreach (var environment in environments) { diff --git a/src/shared-content/scripts/create-and-deploy-release-scripts.include.md b/src/shared-content/scripts/create-and-deploy-release-scripts.include.md index 449f11e029..5f528aa2d3 100644 --- a/src/shared-content/scripts/create-and-deploy-release-scripts.include.md +++ b/src/shared-content/scripts/create-and-deploy-release-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusBaseURL = "https://youroctourl/api" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $headers = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" @@ -61,7 +61,7 @@ $deploymentResponse = Invoke-WebRequest -Uri $octopusSpaceUrl/deployments/create Add-Type -Path 'path\to\Octopus.Client.dll' $octopusBaseURL = "https://youroctourl/" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $endpoint = New-Object Octopus.Client.OctopusServerEndpoint($octopusBaseURL, $octopusAPIKey) $repository = New-Object Octopus.Client.OctopusRepository($endpoint) @@ -151,7 +151,7 @@ using Octopus.Client; using Octopus.Client.Model; var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var endpoint = new OctopusServerEndpoint(octopusURL, octopusAPIKey); var repository = new OctopusRepository(endpoint); @@ -417,7 +417,7 @@ func main() { releaseVersion := "" - // Check to see if the nexversionincrement property is nil + // Check to see if the next version increment property is nil if nil == template["NextVersionIncrement"] { // Project uses a package instead of a template, get the latest version of the package deploymentProcess, err := client.DeploymentProcesses.GetByID(project.DeploymentProcessID) diff --git a/src/shared-content/scripts/create-and-deploy-release-with-tenants-scripts.include.md b/src/shared-content/scripts/create-and-deploy-release-with-tenants-scripts.include.md index c3359bef76..f734a7fd50 100644 --- a/src/shared-content/scripts/create-and-deploy-release-with-tenants-scripts.include.md +++ b/src/shared-content/scripts/create-and-deploy-release-with-tenants-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusBaseURL = "https://youroctourl/api" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $headers = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" @@ -97,7 +97,7 @@ $tenantNames | ForEach-Object { Add-Type -Path 'path\to\Octopus.Client.dll' $octopusBaseURL = "https://youroctourl/" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $endpoint = New-Object Octopus.Client.OctopusServerEndpoint($octopusBaseURL, $octopusAPIKey) $repository = New-Object Octopus.Client.OctopusRepository($endpoint) @@ -195,7 +195,7 @@ using Octopus.Client; using Octopus.Client.Model; var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var endpoint = new OctopusServerEndpoint(octopusURL, octopusAPIKey); var repository = new OctopusRepository(endpoint); @@ -481,7 +481,7 @@ func main() { releaseVersion := "" - // Check to see if the nexversionincrement property is nil + // Check to see if the next version increment property is nil if nil == template["NextVersionIncrement"] { // Project uses a package instead of a template, get the latest version of the package deploymentProcess, err := client.DeploymentProcesses.GetByID(project.DeploymentProcessID) diff --git a/src/shared-content/scripts/create-and-publish-runbook-scripts.include.md b/src/shared-content/scripts/create-and-publish-runbook-scripts.include.md index 13eacfcc88..56ad95eac8 100644 --- a/src/shared-content/scripts/create-and-publish-runbook-scripts.include.md +++ b/src/shared-content/scripts/create-and-publish-runbook-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" $projectName = "MyProject" diff --git a/src/shared-content/scripts/create-api-key-scripts.include.md b/src/shared-content/scripts/create-api-key-scripts.include.md index 59dab5a298..55925cdc1a 100644 --- a/src/shared-content/scripts/create-api-key-scripts.include.md +++ b/src/shared-content/scripts/create-api-key-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } # UserName of the user for which the API key will be created. You can check this value from the web portal under Configuration/Users @@ -43,7 +43,7 @@ Add-Type -Path "C:\octo\Octopus.Client.dll" # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" # Purpose of the API Key. This field is mandatory. $APIKeyPurpose = "" @@ -83,7 +83,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string apiKeyPurpose = "Key used with C# application"; // Create repository object diff --git a/src/shared-content/scripts/create-aws-account-scripts.include.md b/src/shared-content/scripts/create-aws-account-scripts.include.md index 65370828c4..b83fe8a6a7 100644 --- a/src/shared-content/scripts/create-aws-account-scripts.include.md +++ b/src/shared-content/scripts/create-aws-account-scripts.include.md @@ -35,7 +35,7 @@ function Get-OctopusItems return $items } -$apikey = 'API-YOURAPIKEY' # Get this from your profile +$apikey = 'API-YOUR-KEY' # Get this from your profile $OctopusUrl = 'https://youroctourl' # Your Octopus Server address $spaceName = "default" $spaceId = "" @@ -65,7 +65,7 @@ $jsonPayload = @{ } Name = $accountName Description = $accountDescription - TenantedDeploymentparticipation = $accountTenantParticipation + TenantedDeploymentParticipation = $accountTenantParticipation TenantTags = $accountTenantTags TenantIds = $accountTenantIds EnvironmentIds = $accountEnvironmentIds @@ -94,7 +94,7 @@ Invoke-RestMethod -Method Post -Uri "$OctopusUrl/api/$spaceId/accounts" -Body ($ # Load assembly Add-Type -Path 'C:\Octopus.Client\Octopus.Client.dll' $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" # AWS Credentials $awsAccessKey = "AWSAccessKey" @@ -152,7 +152,7 @@ using Octopus.Client; using Octopus.Client.Model; var OctopusURL = "https://youroctourl"; -var OctopusAPIKey = "API-YOURAPIKEY"; +var OctopusAPIKey = "API-YOUR-KEY"; // Azure specific details string awsAccessKey = "AWS Access Key"; @@ -208,7 +208,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} space_name = 'Default' diff --git a/src/shared-content/scripts/create-azure-service-principal-scripts.include.md b/src/shared-content/scripts/create-azure-service-principal-scripts.include.md index 1bfb33e494..b60d82d1c3 100644 --- a/src/shared-content/scripts/create-azure-service-principal-scripts.include.md +++ b/src/shared-content/scripts/create-azure-service-principal-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" @@ -61,7 +61,7 @@ Invoke-RestMethod -Method Post -Uri "$octopusURL/api/$($space.Id)/accounts" -Bod # Load assembly Add-Type -Path 'path\to\Octopus.Client.dll' $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" # Azure service principle details $azureSubscriptionNumber = "Subscription-Guid" @@ -123,7 +123,7 @@ using Octopus.Client; using Octopus.Client.Model; var OctopusURL = "https://youroctourl"; -var OctopusAPIKey = "API-YOURAPIKEY"; +var OctopusAPIKey = "API-YOUR-KEY"; // Azure specific details string azureSubscriptionNumber = "Subscription-Guid"; @@ -182,7 +182,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} space_name = 'Default' diff --git a/src/shared-content/scripts/create-certificate-scripts.include.md b/src/shared-content/scripts/create-certificate-scripts.include.md index 9f6fd95a1b..fccaef2acc 100644 --- a/src/shared-content/scripts/create-certificate-scripts.include.md +++ b/src/shared-content/scripts/create-certificate-scripts.include.md @@ -6,14 +6,14 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" # Certificate details $certificateName = "MyCertificate" $certificateNotes = "" -$certificateFilePath = "path\to\pfxfile.pfx" +$certificateFilePath = "path\to\pfx-file.pfx" $certificatePfxPassword = "PFX-file-password" $certificateEnvironmentIds = @() $certificateTenantIds = @() @@ -58,7 +58,7 @@ Invoke-RestMethod -Method Post -Uri "$octopusURL/api/$($space.Id)/certificates" Add-Type -Path 'path\to\Octopus.Client.dll' # Declare working variables -$apikey = 'API-YOURAPIKEY' # Get this from your profile +$apikey = 'API-YOUR-KEY' # Get this from your profile $octopusURI = 'https://youroctourl' # Your server address $spaceName = 'default' @@ -73,7 +73,7 @@ try $repositoryForSpace = $client.ForSpace($space) # Fill in certificate details - $pfxFilePath = "path\to\pfxfile.pfx" # note: other file formats are supported https://octopus.com/docs/deploying-applications/certificates/file-formats + $pfxFilePath = "path\to\pfx-file.pfx" # note: other file formats are supported https://octopus.com/docs/deploying-applications/certificates/file-formats $pfxBase64 = [Convert]::ToBase64String((Get-Content -Path $pfxFilePath -Encoding Byte)) $pfxPassword = "PFX-file-password" $certificateName = "MyCertificate" # The display name in Octopus @@ -101,8 +101,8 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; -string pfxFilePath = "path\\to\\pfxfile.pfx"; +var octopusAPIKey = "API-YOUR-KEY"; +string pfxFilePath = "path\\to\\pfx-file.pfx"; string pfxFilePassword = "PFX-file-password"; string certificateName = "MyCertificate"; string spaceName = "default"; @@ -142,7 +142,7 @@ import requests import base64 octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): diff --git a/src/shared-content/scripts/create-channel-scripts.include.md b/src/shared-content/scripts/create-channel-scripts.include.md index 72b234fd02..8462a92c3a 100644 --- a/src/shared-content/scripts/create-channel-scripts.include.md +++ b/src/shared-content/scripts/create-channel-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" $projectId = "Projects-101" @@ -52,7 +52,7 @@ $repositoryForSpace = $client.ForSpace($space) # Get project $project = $repositoryForSpace.Projects.FindByName($projectName) -# Createw new channel object +# Create new channel object $channel = New-Object Octopus.Client.Model.ChannelResource $channel.Name = $channelName $channel.ProjectId = $project.Id diff --git a/src/shared-content/scripts/create-google-cloud-account-scripts.include.md b/src/shared-content/scripts/create-google-cloud-account-scripts.include.md index 646d6f09a5..216c87f233 100644 --- a/src/shared-content/scripts/create-google-cloud-account-scripts.include.md +++ b/src/shared-content/scripts/create-google-cloud-account-scripts.include.md @@ -7,7 +7,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" @@ -21,7 +21,7 @@ $accountDescription = "A Google Cloud account for my project" $accountTenantParticipation = "Untenanted" # Google Cloud JSON key file -$jsonKeyPath = "/path/to/jsonkeyfile.json" +$jsonKeyPath = "/path/to/json-key-file.json" # (Optional) Tenant tags e.g.: "AWS Region/California" $accountTenantTags = @() @@ -75,7 +75,7 @@ $accountResponse # https://www.nuget.org/packages/Octopus.Client/ Add-Type -Path 'path\to\Octopus.Client.dll' $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "Default" # Octopus Account name @@ -88,7 +88,7 @@ $accountDescription = "A Google Cloud account for my project" $accountTenantParticipation = "Untenanted" # Google Cloud JSON key file -$jsonKeyPath = "/path/to/jsonkeyfile.json" +$jsonKeyPath = "/path/to/json-key-file.json" # (Optional) Tenant tags e.g.: "AWS Region/California" $accountTenantTags = @() @@ -155,7 +155,7 @@ using Octopus.Client; using Octopus.Client.Model; var OctopusURL = "https://your.octopus.app"; -var OctopusAPIKey = "API-YOURAPIKEY"; +var OctopusAPIKey = "API-YOUR-KEY"; string spaceName = "Default"; // Octopus Account name @@ -168,7 +168,7 @@ string accountDescription = "A Google Cloud account for my project"; Octopus.Client.Model.TenantedDeploymentMode octopusAccountTenantParticipation = Octopus.Client.Model.TenantedDeploymentMode.TenantedOrUntenanted; // Google Cloud JSON key file -string jsonKeyPath = @"/path/to/jsonkeyfile.json"; +string jsonKeyPath = @"/path/to/json-key-file.json"; string jsonKeyBase64 = ""; // (Optional) Tenant tags e.g.: "AWS Region/California" @@ -234,7 +234,7 @@ import requests import base64 octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} space_name = 'Default' @@ -246,8 +246,8 @@ tenant_tags = [] tenant_ids = [] environment_ids = [] -json_keyfile_path = '/path/to/jsonkeyfile.json' -json_data = open(json_keyfile_path, 'rb').read() +json_key_file_path = '/path/to/json-key-file.json' +json_data = open(json_key_file_path, 'rb').read() json_key_base64 = base64.b64encode(json_data) account = { diff --git a/src/shared-content/scripts/create-nuget-feed-scripts.include.md b/src/shared-content/scripts/create-nuget-feed-scripts.include.md index 06ab26c59d..2872c18c91 100644 --- a/src/shared-content/scripts/create-nuget-feed-scripts.include.md +++ b/src/shared-content/scripts/create-nuget-feed-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $feedName = "nuget.org" @@ -56,7 +56,7 @@ Add-Type -Path "C:\Octo\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $feedName = "nuget.org" @@ -121,7 +121,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "Default"; string feedName = "nuget.org 3"; @@ -179,7 +179,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} space_name = 'Default' diff --git a/src/shared-content/scripts/create-project-scripts.include.md b/src/shared-content/scripts/create-project-scripts.include.md index 9afca5bc04..6c927a987b 100644 --- a/src/shared-content/scripts/create-project-scripts.include.md +++ b/src/shared-content/scripts/create-project-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $projectName = "MyProject" @@ -45,7 +45,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $projectName = "MyProject" $projectGroupName = "Default project group" @@ -90,7 +90,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string projectName = "MyProject"; string projectGroupName = "Default project group"; @@ -133,7 +133,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): diff --git a/src/shared-content/scripts/create-projectgroup-scripts.include.md b/src/shared-content/scripts/create-projectgroup-scripts.include.md index 311eb761bb..7e5f087680 100644 --- a/src/shared-content/scripts/create-projectgroup-scripts.include.md +++ b/src/shared-content/scripts/create-projectgroup-scripts.include.md @@ -39,7 +39,7 @@ function Get-OctopusItems # Store call results $items += $resultSet.Items - # Check to see if resultset is bigger than page amount + # Check to see if result set is bigger than page amount if (($resultSet.Items.Count -gt 0) -and ($resultSet.Items.Count -eq $resultSet.ItemsPerPage)) { # Increment skip count diff --git a/src/shared-content/scripts/create-release-with-version-scripts.include.md b/src/shared-content/scripts/create-release-with-version-scripts.include.md index 1efe75c260..a0404e2285 100644 --- a/src/shared-content/scripts/create-release-with-version-scripts.include.md +++ b/src/shared-content/scripts/create-release-with-version-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $projectName = "MyProject" $releaseVersion = "1.0.0.0" @@ -63,7 +63,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $projectName = "MyProject" $channelName = "default" @@ -356,7 +356,7 @@ func main() { releaseVersion := "" - // Check to see if the nexversionincrement property is nil + // Check to see if the NextVersionIncrement property is nil if nil == template["NextVersionIncrement"] { // Project uses a package instead of a template, get the latest version of the package deploymentProcess, err := client.DeploymentProcesses.GetByID(project.DeploymentProcessID) diff --git a/src/shared-content/scripts/create-runbook-scripts.include.md b/src/shared-content/scripts/create-runbook-scripts.include.md index ec6f4cf3a1..ffe45c53db 100644 --- a/src/shared-content/scripts/create-runbook-scripts.include.md +++ b/src/shared-content/scripts/create-runbook-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $projectName = "MyProject" @@ -43,7 +43,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $projectName = "MyProject" $runbookName = "MyRunbook" @@ -95,7 +95,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string projectName = "MyProject"; string runbookName = "MyRunbook"; @@ -145,7 +145,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): diff --git a/src/shared-content/scripts/create-scheduled-runbook-trigger-scripts.include.md b/src/shared-content/scripts/create-scheduled-runbook-trigger-scripts.include.md index ba2b370235..6deabaf6e8 100644 --- a/src/shared-content/scripts/create-scheduled-runbook-trigger-scripts.include.md +++ b/src/shared-content/scripts/create-scheduled-runbook-trigger-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" @@ -95,7 +95,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "Default" $projectName = "MyProject" @@ -178,7 +178,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://your.octopus.app"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; // Define working variables string spaceName = "default"; @@ -271,7 +271,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): diff --git a/src/shared-content/scripts/create-script-step-scripts.include.md b/src/shared-content/scripts/create-script-step-scripts.include.md index 88bd8cb41a..36398b2aad 100644 --- a/src/shared-content/scripts/create-script-step-scripts.include.md +++ b/src/shared-content/scripts/create-script-step-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $role = "My role" @@ -79,11 +79,11 @@ Invoke-RestMethod -Method Put -Uri "$octopusURL/api/$($space.Id)/deploymentproce PowerShell (Octopus.Client) ```powershell -# Load Octopous Client assembly +# Load Octopus Client assembly Add-Type -Path 'c:\octopus.client\Octopus.Client.dll' # Declare Octopus variables -$apikey = 'API-YOURAPIKEY' +$apikey = 'API-YOUR-KEY' $octopusURI = 'https://youroctourl' $projectName = "MyProject" @@ -144,7 +144,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "http://OctoTemp"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string stepName = "Run a script"; string roleName = "My role"; string scriptBody = "Write-Host \"Hello world\""; @@ -203,7 +203,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} diff --git a/src/shared-content/scripts/create-tagset-scripts.include.md b/src/shared-content/scripts/create-tagset-scripts.include.md index 07f5a3fd7f..e018f02d88 100644 --- a/src/shared-content/scripts/create-tagset-scripts.include.md +++ b/src/shared-content/scripts/create-tagset-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" $tagsetName = "Upgrade Ring" @@ -61,7 +61,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "Default" $tagsetName = "Upgrade Ring" $tagsetDescription = "Describes which upgrade ring the tenant belongs to" @@ -112,7 +112,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "Default"; var tagsetName = "Upgrade Ring"; var tagsetDescription = "Describes which upgrade ring the tenant belongs to"; diff --git a/src/shared-content/scripts/delete-a-space-scripts.include.md b/src/shared-content/scripts/delete-a-space-scripts.include.md index 1d66ca463f..0e8ea95fc9 100644 --- a/src/shared-content/scripts/delete-a-space-scripts.include.md +++ b/src/shared-content/scripts/delete-a-space-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "New Space" @@ -41,7 +41,7 @@ Write-Host "Action Complete" Add-Type -Path 'path\to\Octopus.Client.dll' $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $endpoint = New-Object Octopus.Client.OctopusServerEndpoint($octopusURL, $octopusAPIKey) $repository = New-Object Octopus.Client.OctopusRepository($endpoint) @@ -77,7 +77,7 @@ using Octopus.Client; using Octopus.Client.Model; var OctopusURL = "https://youroctourl"; -var OctopusAPIKey = "API-YOURAPIKEY"; +var OctopusAPIKey = "API-YOUR-KEY"; var endpoint = new OctopusServerEndpoint(OctopusURL, OctopusAPIKey); var repository = new OctopusRepository(endpoint); @@ -119,7 +119,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} space_name = "Your Space name" diff --git a/src/shared-content/scripts/delete-feed-scripts.include.md b/src/shared-content/scripts/delete-feed-scripts.include.md index a1542e6e45..b4b9e11b79 100644 --- a/src/shared-content/scripts/delete-feed-scripts.include.md +++ b/src/shared-content/scripts/delete-feed-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $feedName = "nuget.org" @@ -31,7 +31,7 @@ Add-Type -Path "C:\Octo\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $feedName = "nuget.org" @@ -72,7 +72,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "Default"; string feedName = "nuget to delete"; @@ -110,7 +110,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} space_name = "Default" diff --git a/src/shared-content/scripts/delete-project-by-name-scripts.include.md b/src/shared-content/scripts/delete-project-by-name-scripts.include.md index 6062cc19de..253a89ae8c 100644 --- a/src/shared-content/scripts/delete-project-by-name-scripts.include.md +++ b/src/shared-content/scripts/delete-project-by-name-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $projectName = "MyProject" @@ -31,7 +31,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $projectName = "MyProject" @@ -70,7 +70,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "default"; string projectName = "MyProject"; @@ -107,7 +107,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): diff --git a/src/shared-content/scripts/delete-project-releases-scripts.include.md b/src/shared-content/scripts/delete-project-releases-scripts.include.md index 3eb5d1c3fa..fa9b3bbcfe 100644 --- a/src/shared-content/scripts/delete-project-releases-scripts.include.md +++ b/src/shared-content/scripts/delete-project-releases-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $projectName = "MyProject" @@ -38,7 +38,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $projectName = "MyProject" @@ -84,7 +84,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string projectName = "MyProject"; @@ -295,14 +295,14 @@ func GetProject(octopusURL *url.URL, APIKey string, space *octopusdeploy.Space, func GetProjectReleases(octopusURL *url.URL, APIKey string, space *octopusdeploy.Space, project *octopusdeploy.Project) []interface{} { // Define api endpoint - projectReleasesEndoint := octopusURL.String() + "/api/" + space.ID + "/projects/" + project.ID + "/releases" + projectReleasesEndpoint := octopusURL.String() + "/api/" + space.ID + "/projects/" + project.ID + "/releases" // Create http client httpClient := &http.Client{} skipAmount := 0 // Make request - request, _ := http.NewRequest("GET", projectReleasesEndoint, nil) + request, _ := http.NewRequest("GET", projectReleasesEndpoint, nil) request.Header.Set("X-Octopus-ApiKey", APIKey) response, err := httpClient.Do(request) diff --git a/src/shared-content/scripts/delete-projects-without-processes-scripts.include.md b/src/shared-content/scripts/delete-projects-without-processes-scripts.include.md index dc22ae9dc9..1b9884d057 100644 --- a/src/shared-content/scripts/delete-projects-without-processes-scripts.include.md +++ b/src/shared-content/scripts/delete-projects-without-processes-scripts.include.md @@ -89,7 +89,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "default"; // Create repository object @@ -136,7 +136,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): diff --git a/src/shared-content/scripts/delete-targets-by-name-scripts.include.md b/src/shared-content/scripts/delete-targets-by-name-scripts.include.md index fcb5bdb64b..c806fbaa94 100644 --- a/src/shared-content/scripts/delete-targets-by-name-scripts.include.md +++ b/src/shared-content/scripts/delete-targets-by-name-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl/api" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $machineName = "MachineName" @@ -43,7 +43,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl/api" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $machineName = "MachineName" @@ -82,7 +82,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string machineName = "MachineName"; @@ -119,7 +119,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} diff --git a/src/shared-content/scripts/delete-targets-by-role-scripts.include.md b/src/shared-content/scripts/delete-targets-by-role-scripts.include.md index 22e45d28a8..657b2ffec5 100644 --- a/src/shared-content/scripts/delete-targets-by-role-scripts.include.md +++ b/src/shared-content/scripts/delete-targets-by-role-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $role = "MyRole" @@ -35,7 +35,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $role = "MyRole" @@ -78,7 +78,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://your.octopus.app"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string role = "MyRole"; @@ -119,7 +119,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): diff --git a/src/shared-content/scripts/deploy-release-scripts.include.md b/src/shared-content/scripts/deploy-release-scripts.include.md index 49f9fb8d03..47e8d6265f 100644 --- a/src/shared-content/scripts/deploy-release-scripts.include.md +++ b/src/shared-content/scripts/deploy-release-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $headers = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" @@ -52,7 +52,7 @@ $deployment = Invoke-RestMethod -Uri $octopusURL/api/$($space.Id)/deployments -M Add-Type -Path 'path\to\Octopus.Client.dll' $octopusURL = "https://youroctourl/" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "Default" $projectName = "Your Project Name" @@ -159,7 +159,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} @@ -291,14 +291,14 @@ func GetSpace(octopusURL *url.URL, APIKey string, spaceName string) *octopusdepl func GetProjectReleases(octopusURL *url.URL, APIKey string, space *octopusdeploy.Space, project *octopusdeploy.Project) []interface{} { // Define api endpoint - projectReleasesEndoint := octopusURL.String() + "/api/" + space.ID + "/projects/" + project.ID + "/releases" + projectReleasesEndpoint := octopusURL.String() + "/api/" + space.ID + "/projects/" + project.ID + "/releases" // Create http client httpClient := &http.Client{} skipAmount := 0 // Make request - request, _ := http.NewRequest("GET", projectReleasesEndoint, nil) + request, _ := http.NewRequest("GET", projectReleasesEndpoint, nil) request.Header.Set("X-Octopus-ApiKey", APIKey) response, err := httpClient.Do(request) diff --git a/src/shared-content/scripts/deploy-release-with-prompted-variables-scripts.include.md b/src/shared-content/scripts/deploy-release-with-prompted-variables-scripts.include.md index 9816bc52bf..50ec599368 100644 --- a/src/shared-content/scripts/deploy-release-with-prompted-variables-scripts.include.md +++ b/src/shared-content/scripts/deploy-release-with-prompted-variables-scripts.include.md @@ -44,7 +44,7 @@ foreach($element in $deploymentPreview.Form.Elements) $uniqueName = $element.Name $isRequired = $element.Control.Required - $promptedVariablefound = $false + $promptedVariableFound = $false Write-Host "Looking for the prompted variable value for $nameToSearchFor" foreach ($promptedValue in $promptedValueList) @@ -453,14 +453,14 @@ func GetSpace(octopusURL *url.URL, APIKey string, spaceName string) *octopusdepl func GetProjectReleases(octopusURL *url.URL, APIKey string, space *octopusdeploy.Space, project *octopusdeploy.Project) []interface{} { // Define api endpoint - projectReleasesEndoint := octopusURL.String() + "/api/" + space.ID + "/projects/" + project.ID + "/releases" + projectReleasesEndpoint := octopusURL.String() + "/api/" + space.ID + "/projects/" + project.ID + "/releases" // Create http client httpClient := &http.Client{} skipAmount := 0 // Make request - request, _ := http.NewRequest("GET", projectReleasesEndoint, nil) + request, _ := http.NewRequest("GET", projectReleasesEndpoint, nil) request.Header.Set("X-Octopus-ApiKey", APIKey) response, err := httpClient.Do(request) diff --git a/src/shared-content/scripts/disable-project-triggers-scripts.include.md b/src/shared-content/scripts/disable-project-triggers-scripts.include.md index 8bbb658a63..455a887bd2 100644 --- a/src/shared-content/scripts/disable-project-triggers-scripts.include.md +++ b/src/shared-content/scripts/disable-project-triggers-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" $projectName = "MyProject" @@ -39,7 +39,7 @@ Add-Type -Path "c:\octopus.client\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $projectName = "MyProject" @@ -86,7 +86,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "default"; string projectName = "MyProject"; @@ -130,7 +130,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): diff --git a/src/shared-content/scripts/download-artifact-from-deployment-scripts.include.md b/src/shared-content/scripts/download-artifact-from-deployment-scripts.include.md index 034b1e14ce..d34f74ecd6 100644 --- a/src/shared-content/scripts/download-artifact-from-deployment-scripts.include.md +++ b/src/shared-content/scripts/download-artifact-from-deployment-scripts.include.md @@ -7,7 +7,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $OctopusURL = "YOUR INSTANCE URL" $SpaceName = "YOUR SPACE NAME" -$APIKey = "API-YOURAPIKEY" +$APIKey = "API-YOUR-KEY" $projectName = "YOUR PROJECT NAME" $releaseVersion = "YOUR RELEASE VERSION" $environmentName = "YOUR ENVIRONMENT NAME" diff --git a/src/shared-content/scripts/download-artifact-from-runbook-scripts.include.md b/src/shared-content/scripts/download-artifact-from-runbook-scripts.include.md index 3f7cf05930..5079b73065 100644 --- a/src/shared-content/scripts/download-artifact-from-runbook-scripts.include.md +++ b/src/shared-content/scripts/download-artifact-from-runbook-scripts.include.md @@ -5,7 +5,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" $projectName = "My Project" @@ -112,7 +112,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://your.octopus.app"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "Default"; string projectName = "My Project"; string runbookName = "My Runbook"; diff --git a/src/shared-content/scripts/download-package-scripts.include.md b/src/shared-content/scripts/download-package-scripts.include.md index 52bc25e89c..84978169c7 100644 --- a/src/shared-content/scripts/download-package-scripts.include.md +++ b/src/shared-content/scripts/download-package-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" $packageName = "packageName" @@ -35,7 +35,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "Default" $packageName = "packageName" $packageVersion = "1.0.0.0" @@ -78,10 +78,10 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "Default"; -string packageName = "packagename"; +string packageName = "package_name"; string packageVersion = "1.0.0.0"; string outputFolder = @"C:\Temp\"; @@ -126,7 +126,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): @@ -141,7 +141,7 @@ def get_by_name(uri, name): space_name = "Default" package_output_folder = '/path/to/output/package/to' -package_name = 'packagename' +package_name = 'package_name' package_version = '1.0.0.0' space = get_by_name('{0}/spaces/all'.format(octopus_server_uri), space_name) diff --git a/src/shared-content/scripts/enable-disable-machine-scripts.include.md b/src/shared-content/scripts/enable-disable-machine-scripts.include.md index 17a0ad3f02..987e638782 100644 --- a/src/shared-content/scripts/enable-disable-machine-scripts.include.md +++ b/src/shared-content/scripts/enable-disable-machine-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $machineName = "MyMachine" $machineEnabled = $true @@ -34,7 +34,7 @@ Add-Type -Path "c:\octopus.client\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $machineName = "MyMachine" $machineEnabled = $true @@ -77,7 +77,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "default"; var machineName = "MyMachine"; bool enabled = false; @@ -118,7 +118,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} diff --git a/src/shared-content/scripts/environment-permissions-report.include.md b/src/shared-content/scripts/environment-permissions-report.include.md index 3ea8b53151..90769e6be6 100644 --- a/src/shared-content/scripts/environment-permissions-report.include.md +++ b/src/shared-content/scripts/environment-permissions-report.include.md @@ -100,7 +100,7 @@ function Invoke-OctopusApi Write-OctopusVerbose "Ignoring cache." } - Write-OctopusVerbose "No data to post or put, calling bog standard invoke-restmethod for $url" + Write-OctopusVerbose "No data to post or put, calling bog standard Invoke-RestMethod for $url" $result = Invoke-RestMethod -Method $method -Uri $url -Headers @{"X-Octopus-ApiKey" = "$ApiKey" } -ContentType 'application/json; charset=utf-8' if ($cachedResults.ContainsKey($url) -eq $true) @@ -1136,7 +1136,7 @@ class Permission } } - public bool IncludScope + public bool IncludeScope { get; set; @@ -1280,7 +1280,7 @@ static System.Collections.Generic.List GetEnvironmentsScopedToProject (P { if (!scopedEnvironments.Contains(environmentId)) { - Console.WriteLine(string.Format("Adding {0} to {1} environemnt list", environmentId, Project.Name)); + Console.WriteLine(string.Format("Adding {0} to {1} environment list", environmentId, Project.Name)); scopedEnvironments.Add(environmentId); } } @@ -1454,7 +1454,7 @@ static void WritePermissionList (string PermissionName, System.Collections.Gener var octopusURL = "https://YourURL"; var octopusAPIKey = "API-YourAPIKey"; string spaceFilter = "all"; -string environmentfilter = "Development"; +string environmentFilter = "Development"; string permissionToCheck = "DeploymentCreate"; string reportPath = "path:\\to\\csv.file"; string userFilter = "all"; @@ -1481,7 +1481,7 @@ foreach (var spaceName in spaceList) var projectList = repositoryForSpace.Projects.GetAll(); var environmentList = repositoryForSpace.Environments.GetAll(); - environmentList = FilterEnvironmentList(environmentList, environmentfilter); + environmentList = FilterEnvironmentList(environmentList, environmentFilter); var tenantList = repositoryForSpace.Tenants.GetAll(); diff --git a/src/shared-content/scripts/find-events-by-date-scripts.include.md b/src/shared-content/scripts/find-events-by-date-scripts.include.md index 0246b77c87..248eead39b 100644 --- a/src/shared-content/scripts/find-events-by-date-scripts.include.md +++ b/src/shared-content/scripts/find-events-by-date-scripts.include.md @@ -87,7 +87,7 @@ Add-Type -Path "path:\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $eventDate = "8/1/2021" diff --git a/src/shared-content/scripts/find-projects-using-variable-set-scripts.include.md b/src/shared-content/scripts/find-projects-using-variable-set-scripts.include.md index 0165054734..43de96b239 100644 --- a/src/shared-content/scripts/find-projects-using-variable-set-scripts.include.md +++ b/src/shared-content/scripts/find-projects-using-variable-set-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $librarySetName = "MyLibrarySet" @@ -42,7 +42,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $librarySetName = "MyLibrarySet" @@ -91,7 +91,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string librarySetName = "MyLibrarySet"; @@ -138,7 +138,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): @@ -152,10 +152,10 @@ def get_by_name(uri, name): return next((x for x in resources if x['Name'] == name), None) space_name = 'Default' -libraryset_name = 'Your variable set name' +library_set_name = 'Your variable set name' space = get_by_name('{0}/spaces/all'.format(octopus_server_uri), space_name) -library_variable_set = get_by_name('{0}/{1}/libraryvariablesets/all'.format(octopus_server_uri, space['Id']), libraryset_name) +library_variable_set = get_by_name('{0}/{1}/libraryvariablesets/all'.format(octopus_server_uri, space['Id']), library_set_name) library_variable_set_id = library_variable_set['Id'] projects = get_octopus_resource('{0}/{1}/projects/all'.format(octopus_server_uri, space['Id'])) @@ -163,7 +163,7 @@ projects = get_octopus_resource('{0}/{1}/projects/all'.format(octopus_server_uri for project in projects: project_variable_sets = project['IncludedLibraryVariableSetIds'] if library_variable_set_id in project_variable_sets: - print('Project \'{0}\' is using library variable set \'{1}\''.format(project['Name'], libraryset_name)) + print('Project \'{0}\' is using library variable set \'{1}\''.format(project['Name'], library_set_name)) ```
diff --git a/src/shared-content/scripts/find-target-usage-no-tenants.include.md b/src/shared-content/scripts/find-target-usage-no-tenants.include.md index 06dd273e92..5306cb181e 100644 --- a/src/shared-content/scripts/find-target-usage-no-tenants.include.md +++ b/src/shared-content/scripts/find-target-usage-no-tenants.include.md @@ -61,7 +61,7 @@ function Invoke-OctopusApi return Invoke-RestMethod -Method $methodToUse -Uri $url -Headers @{"X-Octopus-ApiKey" = "$ApiKey" } -Body $body -ContentType 'application/json; charset=utf-8' } - Write-Verbose "No data to post or put, calling bog standard invoke-restmethod for $url" + Write-Verbose "No data to post or put, calling bog standard Invoke-RestMethod for $url" $result = Invoke-RestMethod -Method $methodToUse -Uri $url -Headers @{"X-Octopus-ApiKey" = "$ApiKey" } -ContentType 'application/json; charset=utf-8' return $result @@ -132,7 +132,7 @@ function Get-ProjectEnvironmentIds $environmentIds = @() foreach ($lifecycleId in $lifeCycleIds) { - $lifecycle = Invoke-OctopusApi -octopusUrl $octopusUrl -spaceId $spaceid -apiKey $octopusApiKey -endPoint "lifecycles/$lifecycleId" + $lifecycle = Invoke-OctopusApi -octopusUrl $octopusUrl -spaceId $spaceId -apiKey $octopusApiKey -endPoint "lifecycles/$lifecycleId" $phases = $lifecycle.Phases @@ -293,7 +293,7 @@ if ($null -eq $target) Write-Host "The id for $targetName is $($target.Id)" -$environmentList = Invoke-OctopusApi -octopusUrl $octopusurl -endPoint "environments?skip=0&take=10000" -spaceId $spaceId -apiKey $octopusApiKey +$environmentList = Invoke-OctopusApi -octopusUrl $octopusUrl -endPoint "environments?skip=0&take=10000" -spaceId $spaceId -apiKey $octopusApiKey $allEnvironmentIds = @($environmentList.Items |Select-Object -ExpandProperty Id) $targetResults = @() @@ -436,7 +436,7 @@ function Get-EnvironmentsScopedToProject { if ($scopedEnvironmentList -notcontains $environmentId) { - Write-Host "Adding $environmentId to $($project.Name) enviornment list" + Write-Host "Adding $environmentId to $($project.Name) environment list" $scopedEnvironmentList += $environmentId } } @@ -445,7 +445,7 @@ function Get-EnvironmentsScopedToProject { if ($scopedEnvironmentList -notcontains $environmentId) { - Write-Host "Adding $environmentId to $($project.Name) enviornment list" + Write-Host "Adding $environmentId to $($project.Name) environment list" $scopedEnvironmentList += $environmentId } } @@ -512,7 +512,7 @@ function Get-TargetIsScopedToProcess if (($null -ne $action.ExcludedEnvironments)) { $hasExcludedEnvironmentScoping = $action.ExcludedEnvironments.Count -gt 0 - if ($hasExcludedEnvironmentScopint -eq $true) + if ($hasExcludedEnvironmentScoping -eq $true) { $environmentsTargetCanStillDeployTo = @() foreach ($environmentId in $target.EnvironmentIds) @@ -583,9 +583,9 @@ foreach ($project in $projects) $targetHasMatchingEnvironment = $false # Loop through environments - foreach ($envronmentId in $projectEnvironments) + foreach ($environmentId in $projectEnvironments) { - if ($target.EnvironmentIds -contains $envronmentId) + if ($target.EnvironmentIds -contains $environmentId) { $targetHasMatchingEnvironment = $true break @@ -876,7 +876,7 @@ static System.Collections.Generic.List GetEnvironmentsScopedToProject(Pr { if (!scopedEnvironments.Contains(environmentId)) { - Console.WriteLine(string.Format("Adding {0} to {1} environemnt list", environmentId, Project.Name)); + Console.WriteLine(string.Format("Adding {0} to {1} environment list", environmentId, Project.Name)); scopedEnvironments.Add(environmentId); } } @@ -946,11 +946,11 @@ static bool GetTargetIsScopedToProcess(Octopus.Client.Model.IProcessResource pro if(hasExcludedEnvironmentScoping) { System.Collections.Generic.List environmentsTargetCanStillDeployTo = new System.Collections.Generic.List(); - foreach (var environmetnId in target.EnvironmentIds) + foreach (var environmentId in target.EnvironmentIds) { - if ((!action.ExcludedEnvironments.Contains(environmetnId)) && (projectEnvironmentList.Contains(environmetnId))) + if ((!action.ExcludedEnvironments.Contains(environmentId)) && (projectEnvironmentList.Contains(environmentId))) { - environmentsTargetCanStillDeployTo.Add(environmetnId); + environmentsTargetCanStillDeployTo.Add(environmentId); } } diff --git a/src/shared-content/scripts/find-teams-with-role-scripts.include.md b/src/shared-content/scripts/find-teams-with-role-scripts.include.md index 6f379ad2c7..696d3333bd 100644 --- a/src/shared-content/scripts/find-teams-with-role-scripts.include.md +++ b/src/shared-content/scripts/find-teams-with-role-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $userRoleName = "Deployment creator" @@ -53,7 +53,7 @@ Add-Type -Path "c:\octopus.client\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $userRoleName = "Deployment creator" @@ -77,7 +77,7 @@ try $teamNames = @() foreach ($team in $teams) { - # Get scopeduserrole + # Get scoped user role $scopedUserRole = $repositoryForSpace.Teams.GetScopedUserRoles($team) | Where-Object {$_.UserRoleId -eq $userRole.Id} # Check for null @@ -115,7 +115,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string userRoleName = "Deployment creator"; @@ -216,7 +216,7 @@ uri = '{0}/api/spaces'.format(octopus_server_uri) spaces = get_octopus_resource(uri, headers) space = next((x for x in spaces if x['Name'] == space_name), None) -# Get userrole +# Get user role uri = '{0}/api/userroles'.format(octopus_server_uri) user_roles = get_octopus_resource(uri, headers) user_role = next((x for x in user_roles if x['Name'] == role_name), None) diff --git a/src/shared-content/scripts/find-unused-projects.include.md b/src/shared-content/scripts/find-unused-projects.include.md index fd68f32b16..69c9344ce1 100644 --- a/src/shared-content/scripts/find-unused-projects.include.md +++ b/src/shared-content/scripts/find-unused-projects.include.md @@ -64,7 +64,7 @@ function Invoke-OctopusApi Write-Verbose "Ignoring cache." } - Write-Verbose "No data to post or put, calling bog standard invoke-restmethod for $url" + Write-Verbose "No data to post or put, calling bog standard Invoke-RestMethod for $url" $result = Invoke-RestMethod -Method $method -Uri $url -Headers @{"X-Octopus-ApiKey" = "$ApiKey" } -ContentType 'application/json; charset=utf-8' if ($cachedResults.ContainsKey($url) -eq $true) @@ -236,7 +236,7 @@ using Octopus.Client; using Octopus.Client.Model; var octopusURL = "https://your.octopus.app"; -var octopusAPIKey = "API-YOURKEY"; +var octopusAPIKey = "API-YOUR-KEY"; DateTime currentUtcTime = DateTime.Now.ToUniversalTime(); System.Collections.Generic.List oldProjects = new System.Collections.Generic.List(); int daysSinceLastRelease = 90; diff --git a/src/shared-content/scripts/find-unused-targets.include.md b/src/shared-content/scripts/find-unused-targets.include.md index 6f644e1cd6..bba261b804 100644 --- a/src/shared-content/scripts/find-unused-targets.include.md +++ b/src/shared-content/scripts/find-unused-targets.include.md @@ -50,7 +50,7 @@ function Invoke-OctopusApi return Invoke-RestMethod -Method $method -Uri $url -Headers @{"X-Octopus-ApiKey" = "$ApiKey" } -Body $body -ContentType 'application/json; charset=utf-8' } - Write-Verbose "No data to post or put, calling bog standard invoke-restmethod for $url" + Write-Verbose "No data to post or put, calling bog standard Invoke-RestMethod for $url" $result = Invoke-RestMethod -Method $method -Uri $url -Headers @{"X-Octopus-ApiKey" = "$ApiKey" } -ContentType 'application/json; charset=utf-8' return $result @@ -718,7 +718,7 @@ def update_categorized_machines(categorized_machines, space, octopus_server_uri, octopus_server_uri = 'https://your.octopus.app' -octopus_api_key = 'API-YOURKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} categorized_machines = { 'NotCountedMachines': [], diff --git a/src/shared-content/scripts/find-variable-usage-scripts.include.md b/src/shared-content/scripts/find-variable-usage-scripts.include.md index f168097a20..b1f41447d5 100644 --- a/src/shared-content/scripts/find-variable-usage-scripts.include.md +++ b/src/shared-content/scripts/find-variable-usage-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } # Specify the Space to search in @@ -49,7 +49,7 @@ foreach ($project in $projects) { $matchingNamedVariables = $projectVariableSet.Variables | Where-Object { $_.Name -ieq "$variableToFind" } if ($null -ne $matchingNamedVariables) { foreach ($match in $matchingNamedVariables) { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name VariableSet = $null MatchType = "Named Project Variable" @@ -68,7 +68,7 @@ foreach ($project in $projects) { $matchingValueVariables = $projectVariableSet.Variables | Where-Object { $_.Value -like "*#{$variableToFind}*" } if ($null -ne $matchingValueVariables) { foreach ($match in $matchingValueVariables) { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name VariableSet = $null MatchType = "Referenced Project Variable" @@ -94,7 +94,7 @@ foreach ($project in $projects) { $propName = $prop.Name $json = $step.$propName | ConvertTo-Json -Compress -Depth 10 if ($null -ne $json -and ($json -like "*$variableToFind*")) { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name VariableSet = $null MatchType = "Step" @@ -128,7 +128,7 @@ foreach ($project in $projects) { $propName = $prop.Name $json = $step.$propName | ConvertTo-Json -Compress -Depth 10 if ($null -ne $json -and ($json -like "*$variableToFind*")) { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name VariableSet = $null MatchType = "Runbook Step" @@ -154,7 +154,7 @@ if ($searchVariableSets -eq $True) { $variables = (Invoke-RestMethod -Method Get "$OctopusURL/$($VariableSet.Links.Variables)" -Headers $header).Variables | Where-Object { $_.Value -like "*#{$variableToFind}*" } $link = ($VariableSet.Links.Self -replace "/api", "app#") -replace "/libraryvariablesets/", "/library/variables/" foreach ($variable in $variables) { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $null VariableSet = $VariableSet.Name MatchType = "Variable Set" @@ -230,8 +230,8 @@ foreach ($project in $projects) { foreach ($match in $matchingNamedVariable) { - # Create new hashtable - $result = [pscustomobject]@{ + # Create new hash table + $result = [PSCustomObject]@{ Project = $project.Name MatchType = "Named Project Variable" Context = $match.Name @@ -251,7 +251,7 @@ foreach ($project in $projects) { foreach ($match in $matchingValueVariables) { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name MatchType = "Referenced Project Variable" Context = $match.Name @@ -280,7 +280,7 @@ foreach ($project in $projects) { if ($action.Properties[$property].Value -like "*$variableToFind*") { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name MatchType = "Step" Context = $step.Name @@ -320,7 +320,7 @@ foreach ($project in $projects) { if ($action.Properties[$property].Value -like "*$variableToFind*") { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name MatchType = "Runbook Step" Context = $runbook.Name @@ -613,7 +613,7 @@ import requests import csv octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): @@ -644,7 +644,7 @@ csv_export_path = '' variable_tracker = [] octopus_server_uri = octopus_server_uri.rstrip('/') -octopus_server_baselink_uri = octopus_server_uri.rstrip('api') +octopus_server_base_link_uri = octopus_server_uri.rstrip('api') space = get_by_name('{0}/spaces/all'.format(octopus_server_uri), space_name) print('Looking for usages of variable named \'{0}\' in space \'{1}\''.format(variable_name, space_name)) @@ -667,7 +667,7 @@ for project in projects: 'Context': variable['Name'], 'AdditionalContext': None, 'Property': None, - 'Link': '{0}{1}/variables'.format(octopus_server_baselink_uri, project_web_uri) + 'Link': '{0}{1}/variables'.format(octopus_server_base_link_uri, project_web_uri) } if tracked_variable not in variable_tracker: variable_tracker.append(tracked_variable) @@ -682,7 +682,7 @@ for project in projects: 'Context': variable['Name'], 'AdditionalContext': variable['Value'], 'Property': None, - 'Link': '{0}{1}/variables'.format(octopus_server_baselink_uri, project_web_uri) + 'Link': '{0}{1}/variables'.format(octopus_server_base_link_uri, project_web_uri) } if tracked_variable not in variable_tracker: variable_tracker.append(tracked_variable) @@ -700,7 +700,7 @@ for project in projects: 'Context': step['Name'], 'Property': step_key, 'AdditionalContext': None, - 'Link': '{0}{1}/deployments/process/steps?actionId={2}'.format(octopus_server_baselink_uri, project_web_uri, step['Actions'][0]['Id']) + 'Link': '{0}{1}/deployments/process/steps?actionId={2}'.format(octopus_server_base_link_uri, project_web_uri, step['Actions'][0]['Id']) } if tracked_variable not in variable_tracker: variable_tracker.append(tracked_variable) @@ -711,7 +711,7 @@ for project in projects: runbooks = runbooks_resource['Items'] for runbook in runbooks: runbook_processes_link = runbook['Links']['RunbookProcesses'] - runbook_process = get_octopus_resource('{0}/{1}'.format(octopus_server_baselink_uri, runbook_processes_link)) + runbook_process = get_octopus_resource('{0}/{1}'.format(octopus_server_base_link_uri, runbook_processes_link)) for step in runbook_process['Steps']: for step_key in step.keys(): step_property_value = str(step[step_key]) @@ -722,7 +722,7 @@ for project in projects: 'Context': runbook['Name'], 'Property': step_key, 'AdditionalContext': step['Name'], - 'Link': '{0}{1}/operations/runbooks/{2}/process/{3}/steps?actionId={4}'.format(octopus_server_baselink_uri, project_web_uri, runbook['Id'], runbook['RunbookProcessId'], step['Actions'][0]['Id']) + 'Link': '{0}{1}/operations/runbooks/{2}/process/{3}/steps?actionId={4}'.format(octopus_server_base_link_uri, project_web_uri, runbook['Id'], runbook['RunbookProcessId'], step['Actions'][0]['Id']) } if tracked_variable not in variable_tracker: variable_tracker.append(tracked_variable) diff --git a/src/shared-content/scripts/find-variable-value-usage-scripts.include.md b/src/shared-content/scripts/find-variable-value-usage-scripts.include.md index d19708d94d..53015f4dc2 100644 --- a/src/shared-content/scripts/find-variable-value-usage-scripts.include.md +++ b/src/shared-content/scripts/find-variable-value-usage-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } @@ -15,7 +15,7 @@ $spaceName = "Default" # Specify the Variable Value to find, without OctoStache syntax -$variableValueToFind = "mytestvalue" +$variableValueToFind = "MyTestValue" # Optional: set a path to export to csv $csvExportPath = "" @@ -68,7 +68,7 @@ foreach ($project in $projects) $ProjectMatchingNamedVariables = $projectVariableSet.Variables | Where-Object {$_.Value -like "*$variableValueToFind*"} if($null -ne $ProjectMatchingNamedVariables) { foreach($match in $ProjectMatchingNamedVariables) { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name VariableSet = $null MatchType = "Named Project Variable" @@ -162,7 +162,7 @@ foreach ($project in $projects) $ProjectMatchingNamedVariables = $projectVariableSet.Variables | Where-Object {$_.Value -like "*$variableValueToFind*"} if($null -ne $ProjectMatchingNamedVariables) { foreach($match in $ProjectMatchingNamedVariables) { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name VariableSet = $null MatchType = "Named Project Variable" @@ -238,7 +238,7 @@ class VariableResult } var octopusURL = "https://your.octopus.app"; -var octopusAPIKey = "API-YOURKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "Default"; string variableValueToFind = "MyValue"; string csvExportPath = "path:\\to\\variable.csv"; diff --git a/src/shared-content/scripts/find-variableset-variables-usage-scripts.include.md b/src/shared-content/scripts/find-variableset-variables-usage-scripts.include.md index 4da7861e31..dcf98e4709 100644 --- a/src/shared-content/scripts/find-variableset-variables-usage-scripts.include.md +++ b/src/shared-content/scripts/find-variableset-variables-usage-scripts.include.md @@ -1,4 +1,4 @@ -
+
PowerShell (REST API) ```powershell @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } # Specify the Space to search in @@ -57,7 +57,7 @@ foreach ($project in $projects) if($null -ne $matchingValueVariables) { foreach($match in $matchingValueVariables) { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name MatchType = "Referenced Project Variable" VariableSetVariable = $variable.Name @@ -91,7 +91,7 @@ foreach ($project in $projects) foreach($variable in $variables) { if($null -ne $json -and ($json -like "*$($variable.Name)*")) { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name MatchType= "Step" VariableSetVariable = $variable.Name @@ -133,7 +133,7 @@ foreach ($project in $projects) foreach($variable in $variables) { if($null -ne $json -and ($json -like "*$($variable.Name)*")) { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name MatchType= "Runbook Step" VariableSetVariable = $variable.Name @@ -166,7 +166,7 @@ if($variableTracking.Count -gt 0) { ```
-
+
PowerShell (Octopus.Client) ```powershell @@ -235,7 +235,7 @@ foreach ($project in $projects) if($null -ne $matchingValueVariables) { foreach($match in $matchingValueVariables) { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name MatchType = "Referenced Project Variable" VariableSetVariable = $variable.Name @@ -267,7 +267,7 @@ foreach ($project in $projects) { if ($action.Properties[$property].Value -like "*$($variable.Name)*") { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name MatchType= "Step" VariableSetVariable = $variable.Name @@ -309,7 +309,7 @@ foreach ($project in $projects) { if ($action.Properties[$property].Value -like "*$($variable.Name)*") { - $result = [pscustomobject]@{ + $result = [PSCustomObject]@{ Project = $project.Name MatchType= "Runbook Step" VariableSetVariable = $variable.Name @@ -343,7 +343,7 @@ if($variableTracking.Count -gt 0) { ```
-
+
C# ```csharp @@ -594,7 +594,7 @@ if (variableTracking.Count > 0) ```
-
+
Python3 ```python @@ -603,7 +603,7 @@ import requests import csv octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): @@ -633,7 +633,7 @@ csv_export_path = '' variable_tracker = [] octopus_server_uri = octopus_server_uri.rstrip('/') -octopus_server_baselink_uri = octopus_server_uri.rstrip('api') +octopus_server_base_link_uri = octopus_server_uri.rstrip('api') space = get_by_name('{0}/spaces/all'.format(octopus_server_uri), space_name) library_variableset_resource = get_by_name('{0}/{1}/libraryvariablesets/all'.format(octopus_server_uri, space['Id']), library_variableset_name) @@ -662,7 +662,7 @@ for project in projects: 'Context': matching_variable['Name'], 'AdditionalContext': matching_variable['Value'], 'Property': None, - 'Link': '{0}{1}/variables'.format(octopus_server_baselink_uri, project_web_uri) + 'Link': '{0}{1}/variables'.format(octopus_server_base_link_uri, project_web_uri) } if tracked_variable not in variable_tracker: variable_tracker.append(tracked_variable) @@ -683,7 +683,7 @@ for project in projects: 'Context': step['Name'], 'Property': step_key, 'AdditionalContext': None, - 'Link': '{0}{1}/deployments/process/steps?actionId={2}'.format(octopus_server_baselink_uri, project_web_uri, step['Actions'][0]['Id']) + 'Link': '{0}{1}/deployments/process/steps?actionId={2}'.format(octopus_server_base_link_uri, project_web_uri, step['Actions'][0]['Id']) } if tracked_variable not in variable_tracker: variable_tracker.append(tracked_variable) @@ -694,7 +694,7 @@ for project in projects: runbooks = runbooks_resource['Items'] for runbook in runbooks: runbook_processes_link = runbook['Links']['RunbookProcesses'] - runbook_process = get_octopus_resource('{0}/{1}'.format(octopus_server_baselink_uri, runbook_processes_link)) + runbook_process = get_octopus_resource('{0}/{1}'.format(octopus_server_base_link_uri, runbook_processes_link)) for step in runbook_process['Steps']: for step_key in step.keys(): step_property_value = str(step[step_key]) @@ -708,7 +708,7 @@ for project in projects: 'Context': runbook['Name'], 'Property': step_key, 'AdditionalContext': step['Name'], - 'Link': '{0}{1}/operations/runbooks/{2}/process/{3}/steps?actionId={4}'.format(octopus_server_baselink_uri, project_web_uri, runbook['Id'], runbook['RunbookProcessId'], step['Actions'][0]['Id']) + 'Link': '{0}{1}/operations/runbooks/{2}/process/{3}/steps?actionId={4}'.format(octopus_server_base_link_uri, project_web_uri, runbook['Id'], runbook['RunbookProcessId'], step['Actions'][0]['Id']) } if tracked_variable not in variable_tracker: variable_tracker.append(tracked_variable) @@ -736,7 +736,7 @@ if results_count > 0: ```
-
+
Go ```go diff --git a/src/shared-content/scripts/get-feeds-scripts.include.md b/src/shared-content/scripts/get-feeds-scripts.include.md index bcdd111a4e..4a6aa677d3 100644 --- a/src/shared-content/scripts/get-feeds-scripts.include.md +++ b/src/shared-content/scripts/get-feeds-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" @@ -32,7 +32,7 @@ Add-Type -Path "C:\Octo\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $endpoint = New-Object Octopus.Client.OctopusServerEndpoint $octopusURL, $octopusAPIKey @@ -75,7 +75,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "Default"; @@ -117,7 +117,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} space_name = 'Default' diff --git a/src/shared-content/scripts/get-steps-using-package-scripts.include.md b/src/shared-content/scripts/get-steps-using-package-scripts.include.md index 283db7eeac..e813337bed 100644 --- a/src/shared-content/scripts/get-steps-using-package-scripts.include.md +++ b/src/shared-content/scripts/get-steps-using-package-scripts.include.md @@ -53,7 +53,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $packageId = "PackageId" @@ -99,7 +99,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string packageId = "PackageId"; diff --git a/src/shared-content/scripts/get-steps-using-role-scripts.include.md b/src/shared-content/scripts/get-steps-using-role-scripts.include.md index f6f5212763..b71a4abe1f 100644 --- a/src/shared-content/scripts/get-steps-using-role-scripts.include.md +++ b/src/shared-content/scripts/get-steps-using-role-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $roleName = "My role" @@ -34,7 +34,7 @@ foreach ($project in $projectList) # Get steps foreach ($step in $deploymentProcess.Steps) { - if (($null -ne $step.Properties.'Octopus.Action.TargetRoles') -and ($step.properties.'Octopus.Action.TargetRoles'.Split(',') -Icontains $roleName )) + if (($null -ne $step.Properties.'Octopus.Action.TargetRoles') -and ($step.properties.'Octopus.Action.TargetRoles'.Split(',') -icontains $roleName )) { Write-Host "Step $($step.Name) of $($project.Name) is using role $roleName" } @@ -51,7 +51,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $roleName = "My role" @@ -75,7 +75,7 @@ foreach($project in $projectList) # Loop through steps foreach ($step in $deploymentProcess.Steps) { - if($step.properties.'Octopus.Action.TargetRoles' -and ($step.Properties.'Octopus.Action.TargetRoles'.Value.Split(',') -Icontains $roleName)) + if($step.properties.'Octopus.Action.TargetRoles' -and ($step.Properties.'Octopus.Action.TargetRoles'.Value.Split(',') -icontains $roleName)) { "Step [$($step.Name)] from project [$($project.Name)] is using the role [$($roleName )]" } @@ -96,7 +96,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string roleName = "My role"; @@ -150,7 +150,7 @@ catch (Exception ex) import json import requests octopus_server_uri = 'https://your.octopus.app/' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): response = requests.get(uri, headers=headers) diff --git a/src/shared-content/scripts/list-users-scripts.include.md b/src/shared-content/scripts/list-users-scripts.include.md index 74466ff40e..555243f562 100644 --- a/src/shared-content/scripts/list-users-scripts.include.md +++ b/src/shared-content/scripts/list-users-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://your.octopus.app" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } # Optional: include user role details? @@ -35,7 +35,7 @@ do { # Filter non-active users if($includeNonActiveUsers -eq $False) { - Write-Host "Filtering users who arent active from results" + Write-Host "Filtering users who aren't active from results" $usersList = $usersList | Where-Object {$_.IsActive -eq $True} } @@ -181,7 +181,7 @@ $usersList = @() if ($includeNonActiveUsers -eq $true) { # Filter out inactive users - Write-Host "Filtering users who arent active from results" + Write-Host "Filtering users who aren't active from results" $users = $users | Where-Object {$_.IsActive -eq $True} } diff --git a/src/shared-content/scripts/list-users-with-editing-roles-scripts.include.md b/src/shared-content/scripts/list-users-with-editing-roles-scripts.include.md index 42cfc3cece..aa8fb68d05 100644 --- a/src/shared-content/scripts/list-users-with-editing-roles-scripts.include.md +++ b/src/shared-content/scripts/list-users-with-editing-roles-scripts.include.md @@ -71,7 +71,7 @@ Add-Type -Path 'path:\to\Octopus.Client.dll' # Define working variables $octopusURL = "https://YourURL" $octopusAPIKey = "API-YourAPIKey" -$csvExportPath = "path:\to\editpermissions.csv" +$csvExportPath = "path:\to\edit-permissions.csv" $endpoint = New-Object Octopus.Client.OctopusServerEndpoint($octopusURL, $octopusAPIKey) $repository = New-Object Octopus.Client.OctopusRepository($endpoint) @@ -179,7 +179,7 @@ class UserDetails var octopusURL = "https://YourURL"; var octopusAPIKey = "API-YourAPIKey"; -string csvExportPath = "path:\\to\\editpermissions.csv"; +string csvExportPath = "path:\\to\\edit-permissions.csv"; System.Collections.Generic.List usersList = new System.Collections.Generic.List(); @@ -306,7 +306,7 @@ def get_octopus_resource(uri, headers, skip_count = 0): octopus_server_uri = 'https://YourURL' octopus_api_key = 'API-YourAPIKey' headers = {'X-Octopus-ApiKey': octopus_api_key} -csv_export_path = "path:\\to\\editpermissions.csv" +csv_export_path = "path:\\to\\edit-permissions.csv" # Get users uri = '{0}/api/users'.format(octopus_server_uri) @@ -382,7 +382,7 @@ func main() { log.Println(err) } APIKey := "API-YourAPIKey" - csvExportPath := "path:\\to\\editpermissions.csv" + csvExportPath := "path:\\to\\edit-permissions.csv" usersList := []UserDetails{} diff --git a/src/shared-content/scripts/promote-releases-not-in-destination.include.md b/src/shared-content/scripts/promote-releases-not-in-destination.include.md index b87b665e47..bc79b9f875 100644 --- a/src/shared-content/scripts/promote-releases-not-in-destination.include.md +++ b/src/shared-content/scripts/promote-releases-not-in-destination.include.md @@ -41,7 +41,7 @@ function Invoke-OctopusApi return Invoke-RestMethod -Method $method -Uri $url -Headers @{"X-Octopus-ApiKey" = "$ApiKey" } -Body $body -ContentType 'application/json; charset=utf-8' } - Write-Host "No data to post or put, calling bog standard invoke-restmethod for $url" + Write-Host "No data to post or put, calling bog standard Invoke-RestMethod for $url" $result = Invoke-RestMethod -Method $method -Uri $url -Headers @{"X-Octopus-ApiKey" = "$ApiKey" } -ContentType 'application/json; charset=utf-8' return $result @@ -160,7 +160,7 @@ foreach ($projectName in $splitProjectList) TenantId = $null UseGuidedFailure = $false } - $newDeployment = Invoke-OctopusApi -octopusUrl $octopusurl -apiKey $apiKey -method "POST" -spaceId $spaceId -item $newDeployment -endPoint "deployments" + $newDeployment = Invoke-OctopusApi -octopusUrl $octopusUrl -apiKey $apiKey -method "POST" -spaceId $spaceId -item $newDeployment -endPoint "deployments" } ``` diff --git a/src/shared-content/scripts/publish-runbook-scripts.include.md b/src/shared-content/scripts/publish-runbook-scripts.include.md index 4bd057f579..43c8cda7ad 100644 --- a/src/shared-content/scripts/publish-runbook-scripts.include.md +++ b/src/shared-content/scripts/publish-runbook-scripts.include.md @@ -7,12 +7,12 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $projectName = "MyProject" $runbookName = "MyRunbook" -$snapshotName = "Snapshot 9PNENH6" +$snapshotName = "Snapshot XXXXX" # Get space $space = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/spaces/all" -Headers $header) | Where-Object {$_.Name -eq $spaceName} @@ -41,11 +41,11 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $projectName = "MyProject" $runbookName = "MyRunbook" -$snapshotName = "Snapshot 9PNENH7" +$snapshotName = "Snapshot XXXXX" $endpoint = New-Object Octopus.Client.OctopusServerEndpoint $octopusURL, $octopusAPIKey $repository = New-Object Octopus.Client.OctopusRepository $endpoint @@ -93,7 +93,7 @@ var octopusAPIKey = "API-APIKEY"; string spaceName = "default"; string projectName = "MyProject"; string runbookName = "MyRunbook"; -string snapshotName = "Snapshot 7PNENH8"; +string snapshotName = "Snapshot XXXXX"; // Create repository object var endpoint = new OctopusServerEndpoint(octopusURL, octopusAPIKey); @@ -135,7 +135,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): @@ -154,7 +154,7 @@ def get_item_by_name(uri, name): space_name = 'Default' project_name = 'Your project' runbook_name = 'Your runbook' -snapshot_name = 'Snapshot YVVCRLF' +snapshot_name = 'Snapshot XXXXX' space = get_by_name('{0}/spaces/all'.format(octopus_server_uri), space_name) project = get_by_name('{0}/{1}/projects/all'.format(octopus_server_uri, space['Id']), project_name) diff --git a/src/shared-content/scripts/push-package-scripts.include.md b/src/shared-content/scripts/push-package-scripts.include.md index b8fd84b0f5..83afbbdc85 100644 --- a/src/shared-content/scripts/push-package-scripts.include.md +++ b/src/shared-content/scripts/push-package-scripts.include.md @@ -7,7 +7,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $packageFile = "path\to\package" @@ -61,7 +61,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $packageFile = "path\to\package" @@ -79,7 +79,7 @@ try # Create new package resource $package = New-Object Octopus.Client.Model.PackageResource - # Create filestream object + # Create file stream object $fileStream = New-Object System.IO.FileStream($packageFile, [System.IO.FileMode]::Open) # Push package @@ -157,7 +157,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} space_name = "Default" diff --git a/src/shared-content/scripts/register-listening-tentacle-scripts.include.md b/src/shared-content/scripts/register-listening-tentacle-scripts.include.md index e0eb07bc06..6e73e8d810 100644 --- a/src/shared-content/scripts/register-listening-tentacle-scripts.include.md +++ b/src/shared-content/scripts/register-listening-tentacle-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $hostName = "MyHost" @@ -56,7 +56,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $hostName = "MyHost" $tentaclePort = "10933" @@ -115,7 +115,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string hostName = "MyHost"; int tentaclePort = 10933; @@ -174,7 +174,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} @@ -277,7 +277,7 @@ func main() { // Get the space object space := GetSpace(apiURL, APIKey, spaceName) - // Creat client for space + // Create client for space client := octopusAuth(apiURL, APIKey, space.ID) // Get the environment ids diff --git a/src/shared-content/scripts/register-polling-tentacle-scripts.include.md b/src/shared-content/scripts/register-polling-tentacle-scripts.include.md index ce7a5fffdc..e7f9f19dc5 100644 --- a/src/shared-content/scripts/register-polling-tentacle-scripts.include.md +++ b/src/shared-content/scripts/register-polling-tentacle-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $communicationsStyle = "TentacleActive" # Listening mode @@ -60,7 +60,7 @@ Add-Type -Path "c:\octopus.client\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $hostName = "MyHost" $tentacleThumbprint = "TentacleThumbprint" @@ -128,7 +128,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string hostName = "OctoTempTentacle"; string[] environmentNames = { "Development", "Production" }; @@ -195,7 +195,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): @@ -215,7 +215,8 @@ environment_names = ['Development', 'Test'] target_name = 'your-target-name' target_tentacle_thumbprint = 'your-tentacle-thumbprint' -# The subscription id is a random 20 character id (for example: 3hw9vtskv2cbfw7zvpje) that is used to queue messages from the server to the Polling Tentacle. +# The subscription id is a random 20 character id that is used to +# queue messages from the server to the Polling Tentacle. # This should match the value in the Tentacle config file. target_polling_subscription_identifier = 'your-target-subscription' @@ -274,7 +275,7 @@ func main() { // Get the space object space := GetSpace(apiURL, APIKey, spaceName) - // Creat client for space + // Create client for space client := octopusAuth(apiURL, APIKey, space.ID) // Get the environment ids diff --git a/src/shared-content/scripts/remove-project-from-team-scripts.include.md b/src/shared-content/scripts/remove-project-from-team-scripts.include.md index de5b0c81c0..712fc165f1 100644 --- a/src/shared-content/scripts/remove-project-from-team-scripts.include.md +++ b/src/shared-content/scripts/remove-project-from-team-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $projectName = "MyProject" $spaceName = "default" @@ -45,7 +45,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $projectName = "MyProject" $teamName = "MyTeam" @@ -94,7 +94,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "default"; string projectName = "MyProject"; string teamName = "MyTeam"; @@ -241,7 +241,7 @@ func main() { // Get the space object space := GetSpace(apiURL, APIKey, spaceName) - // Creat client for space + // Create client for space client := octopusAuth(apiURL, APIKey, space.ID) // Get team diff --git a/src/shared-content/scripts/replace-certificate-scripts.include.md b/src/shared-content/scripts/replace-certificate-scripts.include.md index c25d08c8ea..2db535cd52 100644 --- a/src/shared-content/scripts/replace-certificate-scripts.include.md +++ b/src/shared-content/scripts/replace-certificate-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" @@ -50,7 +50,7 @@ Invoke-RestMethod -Method Post -Uri "$octopusURL/api/$($space.Id)/certificates/$ Add-Type -Path 'path\to\Octopus.Client.dll' # Provide credentials for Octopus -$apikey = 'API-YOURAPIKEY' +$apikey = 'API-YOUR-KEY' $octopusURI = 'https://youroctourl' $spaceName = "default" @@ -104,7 +104,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; var octopusAPIKey = "API-APIKEY"; -string pfxFilePath = "C:\\path\\to\\thecert.pfx"; +string pfxFilePath = "C:\\path\\to\\the-cert.pfx"; string pfxFilePassword = "PFX-file-password"; string certificateName = "MyCertificate"; string spaceName = "default"; @@ -245,7 +245,7 @@ func main() { if err != nil { log.Println(err) } - APIKey := "API-YourAPIEKey" + APIKey := "API-YourAPIKey" spaceName := "Default" certificateName := "MyCertificate" @@ -255,7 +255,7 @@ func main() { // Get the space object space := GetSpace(apiURL, APIKey, spaceName) - // Creat client for space + // Create client for space client := octopusAuth(apiURL, APIKey, space.ID) rawData, err := ioutil.ReadFile(certificateFilePath) diff --git a/src/shared-content/scripts/run-a-runbook-with-prompted-variables.include.md b/src/shared-content/scripts/run-a-runbook-with-prompted-variables.include.md index 08b0b606d9..9ebbdbf526 100644 --- a/src/shared-content/scripts/run-a-runbook-with-prompted-variables.include.md +++ b/src/shared-content/scripts/run-a-runbook-with-prompted-variables.include.md @@ -122,7 +122,7 @@ if ([string]::IsNullOrWhiteSpace($runbookPromptedVariables) -eq $false) $uniqueName = $element.Name $isRequired = $element.Control.Required - $promptedVariablefound = $false + $promptedVariableFound = $false Write-Host "Looking for the prompted variable value for $nameToSearchFor" foreach ($promptedValue in $promptedValueList) @@ -242,7 +242,7 @@ using Octopus.Client; using Octopus.Client.Model; var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "Default"; string environmentName = "Development"; string runbookName = "Runbook name"; diff --git a/src/shared-content/scripts/run-healthcheck-scripts.include.md b/src/shared-content/scripts/run-healthcheck-scripts.include.md index ff203f2020..d55abc60e2 100644 --- a/src/shared-content/scripts/run-healthcheck-scripts.include.md +++ b/src/shared-content/scripts/run-healthcheck-scripts.include.md @@ -1,4 +1,4 @@ -
+
PowerShell (REST API) ```powershell @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "http://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" $Description = "Health check started from Powershell script" @@ -52,7 +52,7 @@ Invoke-RestMethod -Method Post -Uri "$octopusURL/api/$($space.Id)/tasks" -Body ( ```
-
+
PowerShell (Octopus.Client) ```powershell @@ -61,7 +61,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "Default" $Description = "Health check started from Powershell script" $TimeOutAfterMinutes = 5 @@ -105,7 +105,7 @@ catch ```
-
+
C# ```csharp @@ -117,7 +117,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "Default"; var description = "Health check started from C# script"; var timeoutAfterMinutes = 5; @@ -160,7 +160,7 @@ catch (Exception ex) ```
-
+
Python3 ```python diff --git a/src/shared-content/scripts/run-runbook-scripts.include.md b/src/shared-content/scripts/run-runbook-scripts.include.md index 43e0445b2a..6b448cd24e 100644 --- a/src/shared-content/scripts/run-runbook-scripts.include.md +++ b/src/shared-content/scripts/run-runbook-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl/api" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" $projectName = "MyProject" @@ -45,7 +45,7 @@ Add-Type -Path "c:\octopus.client\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $projectName = "MyProject" $runbookName = "MyRunbook" @@ -114,7 +114,7 @@ using Octopus.Client.Model; // Declare working variables var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; string spaceName = "default"; string projectName = "MyProject"; string runbookName = "MyRunbook"; @@ -181,7 +181,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri): diff --git a/src/shared-content/scripts/update-release-variable-snapshot-scripts.include.md b/src/shared-content/scripts/update-release-variable-snapshot-scripts.include.md index e412c4bbfa..03b773b67c 100644 --- a/src/shared-content/scripts/update-release-variable-snapshot-scripts.include.md +++ b/src/shared-content/scripts/update-release-variable-snapshot-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $projectName = "MyProject" $releaseVersion = "1.0.0.0" @@ -39,7 +39,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $projectName = "MyProject" $channelName = "default" @@ -85,7 +85,7 @@ using Octopus.Client; using Octopus.Client.Model; var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "default"; string projectName = "MyProject"; string channelName = "Default"; diff --git a/src/shared-content/scripts/update-tenant-variable-scripts.include.md b/src/shared-content/scripts/update-tenant-variable-scripts.include.md index e199c5729d..01960cba06 100644 --- a/src/shared-content/scripts/update-tenant-variable-scripts.include.md +++ b/src/shared-content/scripts/update-tenant-variable-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" # Name of the Space @@ -78,7 +78,7 @@ foreach ($projectKey in $projects) } } else { - Write-Host "Couldnt find project template: $variableTemplateName for project $projectName" + Write-Host "Couldn't find project template: $variableTemplateName for project $projectName" } } # Update the variables with the new value @@ -96,7 +96,7 @@ Add-Type -Path 'Octopus.Client.dll' # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "Default" # Name of the Space $tenantName = "TenantName" # The tenant name @@ -166,7 +166,7 @@ try } } else { - Write-Host "Couldnt find project template: $variableTemplateName for project $projectName" + Write-Host "Couldn't find project template: $variableTemplateName for project $projectName" } } @@ -191,7 +191,7 @@ using Octopus.Client; using Octopus.Client.Model; var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "Default"; var tenantName = "TenantName"; var projectVariableTemplateName = "TemplateName"; @@ -229,7 +229,7 @@ try { var variableTemplateId = variableTemplateResource.Id; var variableTemplateIsSensitiveControlType = (variableTemplateResource.DisplaySettings.FirstOrDefault(ds => ds.Key == "Octopus.ControlType")).Value == "Sensitive"; - Console.WriteLine("Found templateid for template: {0} of {1}", projectVariableTemplateName, variableTemplateId); + Console.WriteLine("Found template id for template: {0} of {1}", projectVariableTemplateName, variableTemplateId); // Loop through each of the connected environments foreach (var envKey in project.Variables.Keys) @@ -261,7 +261,7 @@ try } else { - Console.WriteLine("Couldnt find project template: {0} for project {1}", projectVariableTemplateName, projectName); + Console.WriteLine("Couldn't find project template: {0} for project {1}", projectVariableTemplateName, projectName); } } @@ -316,7 +316,7 @@ def get_octopus_resource(uri, headers, skip_count = 0): return items octopus_server_uri = 'https://your.octopus.app' -octopus_api_key = 'API-YOURKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} space_name = "Default" tenant_name = "MyTenant" diff --git a/src/shared-content/scripts/update-variable-set-variable-value-scripts.include.md b/src/shared-content/scripts/update-variable-set-variable-value-scripts.include.md index 73d7a153ea..04a3492f6a 100644 --- a/src/shared-content/scripts/update-variable-set-variable-value-scripts.include.md +++ b/src/shared-content/scripts/update-variable-set-variable-value-scripts.include.md @@ -78,11 +78,11 @@ $librarySet = $repositoryForSpace.LibraryVariableSets.FindByName($libraryVariabl # Check to see if something was returned if ($null -eq $librarySet) { - Write-Warning "Library variable not found with name '$libraryVariabelSetName'" + Write-Warning "Library variable not found with name '$libraryVariableSetName'" exit } -# Get the variableset +# Get the variable set $variableSet = $repositoryForSpace.VariableSets.Get($librarySet.VariableSetId) # Get the variable @@ -104,7 +104,7 @@ using Octopus.Client.Model; using System.Linq; var octopusURL = "https://your.octopus.app"; -var octopusAPIKey = "API-YOURKEY"; +var octopusAPIKey = "API-YOUR-KEY"; // Create repository object var endpoint = new OctopusServerEndpoint(octopusURL, octopusAPIKey); diff --git a/src/shared-content/scripts/upgrade-machines-scripts.include.md b/src/shared-content/scripts/upgrade-machines-scripts.include.md index df420d9e27..76c365888c 100644 --- a/src/shared-content/scripts/upgrade-machines-scripts.include.md +++ b/src/shared-content/scripts/upgrade-machines-scripts.include.md @@ -6,7 +6,7 @@ $ErrorActionPreference = "Stop"; # Define working variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "default" $machineNames = @("MyMachine") @@ -49,7 +49,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" # Octopus variables $octopusURL = "https://youroctourl" -$octopusAPIKey = "API-YOURAPIKEY" +$octopusAPIKey = "API-YOUR-KEY" $spaceName = "default" $machineNames = @("MyMachine") @@ -99,7 +99,7 @@ using Octopus.Client; using Octopus.Client.Model; var octopusURL = "https://youroctourl"; -var octopusAPIKey = "API-YOURAPIKEY"; +var octopusAPIKey = "API-YOUR-KEY"; var spaceName = "default"; string[] machineNames = new string[] { "OctoTempTentacle" }; @@ -150,7 +150,7 @@ import json import requests octopus_server_uri = 'https://your.octopus.app/api' -octopus_api_key = 'API-YOURAPIKEY' +octopus_api_key = 'API-YOUR-KEY' headers = {'X-Octopus-ApiKey': octopus_api_key} def get_octopus_resource(uri):