Skip to content

Add new command aptible apps:settings and image info to aptible apps#414

Merged
UserNotFound merged 4 commits into
masterfrom
app-settings
Jun 5, 2026
Merged

Add new command aptible apps:settings and image info to aptible apps#414
UserNotFound merged 4 commits into
masterfrom
app-settings

Conversation

@UserNotFound

@UserNotFound UserNotFound commented Jun 2, 2026

Copy link
Copy Markdown
Member

Add more info to the JSON output of aptible apps

Adds current image deployment settings to the JSON output format of aptible apps

  • docker_image
  • private_registry_username
  • private_registry_password

Activity implications: when using the JSON output for aptible apps, this adds an activity event for Setting.show for every apps setting. (The same was already true for the app's last operation)

New command: aptible apps:settings

Adds a new command aptible apps:settings that is geared towards viewing just information needed to deploy, or related to the current/last deployment. This is geared towards both an end user, and automation via the JSON output. This is easier to use (namely, targeting a single app by it's handle) than parsing the JSON output of aptible apps

Human use:

$ aptible apps:settings deploy-action-demo --env chaos
Id: 20120
Handle: deploy-action-demo
Created At: 2020-05-01 20:25:58 UTC
Environment: chaos
Status: provisioned
Git Remote: git@beta.aptible.com:chaos/deploy-action-demo.git
Last Deploy Operation: 97890638
Docker Image: aptible/github-action-demo
Private Registry Username:
Private Registry Password:

Machine use:

$ APTIBLE_OUTPUT_FORMAT=json aptible apps:settings deploy-action-demo --env chaos
{
  "id": 20120,
  "handle": "deploy-action-demo",
  "created_at": "2020-05-01 20:25:58 UTC",
  "environment": {
    "id": 3369,
    "handle": "chaos",
    "created_at": "2019-10-29 17:12:39 UTC"
  },
  "status": "provisioned",
  "git_remote": "git@beta.aptible.com:chaos/deploy-action-demo.git",
  "last_deploy_operation": {
    "id": 97890638,
    "status": "succeeded",
    "git_ref": null,
    "user_email": "support+ops@aptible.com",
    "created_at": "2025-12-01 17:21:16 UTC"
  },
  "docker_image": "aptible/github-action-demo",
  "private_registry_username": null,
  "private_registry_password": null
}

Activity implications: this creates a Setting.show activity and an Operation.show activity for the app you ask for, both for text and json.

Required related changes

Docs and tests:

@UserNotFound UserNotFound changed the title Add image info to app list JSON Add new command aptible apps:settings and image info to aptible apps Jun 2, 2026
@UserNotFound UserNotFound requested a review from almathew June 2, 2026 21:10
@UserNotFound UserNotFound marked this pull request as ready for review June 2, 2026 21:10
@promptless

promptless Bot commented Jun 2, 2026

Copy link
Copy Markdown

Promptless prepared a documentation update related to this change.

Triggered by PR #414

Documents the new aptible apps:settings command with synopsis, examples (text and JSON output), and output fields reference. Also adds JSON output documentation for the new docker_image, private_registry_username, and private_registry_password fields in aptible apps.

Review: Document apps:settings command

@UserNotFound UserNotFound merged commit 330da2f into master Jun 5, 2026
10 checks passed
@UserNotFound

Copy link
Copy Markdown
Member Author

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.

2 participants