Skip to content

docs: sample GitHub Action for coded app CI/CD#541

Open
Raina451 wants to merge 14 commits into
mainfrom
docs/ci-cd-deploy-coded-app
Open

docs: sample GitHub Action for coded app CI/CD#541
Raina451 wants to merge 14 commits into
mainfrom
docs/ci-cd-deploy-coded-app

Conversation

@Raina451

@Raina451 Raina451 commented Jun 19, 2026

Copy link
Copy Markdown
Collaborator

Sample GitHub Actions workflow showing how to deploy a UiPath Coded App via the uip CLI using external app (service.external) authentication.

Steps: login → pack → publish → deploy. Triggered via workflow_dispatch with app name, path name, and target environment as inputs.

Prereqs: UIPATH_CLIENT_ID and UIPATH_CLIENT_SECRET as repo secrets from an external app registered in UiPath Cloud.

sample run: https://github.com/UiPath/uipath-typescript/actions/runs/27931348031 from test branch: https://github.com/UiPath/uipath-typescript/blob/test/ci-cd-workflow-validation/.github/workflows/test-deploy-coded-app.yml

Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread samples/ci-cd-workflows/deploy-coded-app.yml Fixed
Comment thread .github/workflows/deploy-coded-app.yml Outdated
Comment thread samples/ci-cd-workflows/deploy-coded-app.yml Outdated
@claude

claude Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Review summary

Two bugs in the new workflow file:

1. Misleading trigger comment (line 3) — The comment says 'push to main (auto-deploy)' but there is no push trigger in on:. Either add it or correct the comment.

2. Undefined variables UIPATH_ORG / UIPATH_TENANT (lines 59–60) — These are referenced in the uip login step but declared nowhere (not inputs, not env:, not secrets). Both will be empty strings at runtime, causing the login step to fail.

Raina451 and others added 2 commits June 19, 2026 14:53
Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread samples/ci-cd-workflows/deploy-coded-app.yml Outdated
@claude

claude Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Review summary

One new finding this run:

Unversioned uip CLI install (line 57)npm install -g @uipath/uip with no version pin means every workflow run pulls the latest release, including potentially breaking changes. The sample should pin to a specific validated version for reproducibility.


Two previously-raised threads remain open:

  • Misleading trigger comment (thread on .github/workflows/deploy-coded-app.yml) — file has moved to samples/, comment appears resolved in the new path
  • Undefined $UIPATH_ORG / $UIPATH_TENANT (line 63–64) — still present; awaiting fix

Raina451 and others added 2 commits June 19, 2026 16:59
Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread samples/ci-cd-workflows/README.md Outdated
@claude

claude Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Review summary

One new finding this run:

README missing UIPATH_ORG/UIPATH_TENANT setup instructions (line 13)samples/ci-cd-workflows/README.md step 3 only tells users to add the two secrets but never mentions configuring UIPATH_ORG and UIPATH_TENANT as repository variables. A user following the README as written will hit a broken workflow.


Two previously-raised threads remain open (not re-raised this run):

  • Undefined $UIPATH_ORG/$UIPATH_TENANT in sample YAML (line 64 of deploy-coded-app.yml) — bare shell vars are never populated at runtime; should use ${{ vars.UIPATH_ORG }}
  • Unversioned uip CLI install (line 57 of deploy-coded-app.yml) — npm install -g @uipath/uip with no version pin

Comment thread mkdocs.yml Outdated
Comment thread docs/coded-apps/ci-cd-github-actions.md
- Remove duplicate samples/ci-cd-workflows (keep only in docs)
- Make CI/CD a dropdown nav in mkdocs for future recipes

Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
@claude

claude Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Review summary

One new finding this run:

Default environment is alpha (line 36) — The environment input defaults to "alpha", an internal UiPath pre-release environment. Users who run the workflow without changing the dropdown will target https://alpha.uipath.com instead of production. Should default to "cloud".

Raina451 and others added 2 commits June 19, 2026 19:09
Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
@claude

claude Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
@claude

claude Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Review summary

One new finding this run:

Walkthrough hardcodes alpha.uipath.com (line 96) — The ## Walkthrough section uses --authority "https://alpha.uipath.com" in the login command example. Alpha is an internal UiPath pre-release environment; external users who copy this command verbatim will target the wrong environment. Should be cloud.uipath.com (or a generic placeholder), consistent with the fix needed on line 36's default: "alpha".


Previously-raised threads still open (not re-raised this run):

  • Default environment is alpha (line 36) — workflow input default should be cloud
  • Content duplication (line 23) — reviewer question about docs vs samples

Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
- Use "Confidential External Application" + "Admin portal"
- Remove --authority (default to cloud.uipath.com)
- Move org/tenant/folder-key to workflow inputs
- Add --folder-key to deploy step
- Remove Walkthrough section, add inline YAML comments
- Remove UIPATH_ORG/UIPATH_TENANT variables from prerequisites

Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
@claude

claude Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Review summary

Two new findings this run:

1. CLI install contradicts its own comment (line 65) — The comment directly above the step says "Pin to a specific version for reproducible builds" but the command is npm install -g @uipath/uip with no version. Should be @uipath/uip@1.4.0 (or whatever version was validated) to match the comment and the "Pin CLI version" variation shown at the bottom of the file.

2. "Deploy on push" variation is incomplete (line 98) — The variation only shows replacing on: and adding env: variables, but the step run: commands still reference ${{ inputs.org }}, ${{ inputs.app-name }} etc. Those expressions are empty on a push event, so uip login and uip codedapp deploy will fail silently. The variation needs to show the updated step expressions using ${{ env.ORG }} etc., or at minimum call out which references to update.

Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
- Add uip tools install codedapp step
- Add --name flag to pack command for non-interactive mode
- Fix comment casing on CLI pin
- Fix "Deploy on push" variation to use env vars instead of inputs

Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
@claude

claude Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
@claude

claude Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

@Raina451 Raina451 marked this pull request as ready for review June 22, 2026 05:23
@Raina451 Raina451 requested a review from a team June 22, 2026 05:23
Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
@claude

claude Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Review summary

One new finding this run:

Hardcoded UUID placeholder (line 119)FOLDER_KEY: "8645d674-92d8-4281-9aef-43f3e3608ded" in the "Deploy on push to main" variation looks like a real UUID, unlike the obviously fake myorg/mytenant/my-app values alongside it. A user may copy it verbatim without realising it must be replaced. Suggest using "<your-folder-key>" instead.


All prior review threads are resolved and their changes are reflected in the current file.

Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
@claude

claude Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
Comment thread docs/coded-apps/ci-cd-github-actions.md Outdated
Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
@claude

claude Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

@Raina451 Raina451 requested a review from vnaren23 June 22, 2026 09:19
@sonarqubecloud

Copy link
Copy Markdown

Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
@claude

claude Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants