From 0d40b31791ce6ec57d41c8eff487c15d23013388 Mon Sep 17 00:00:00 2001 From: Jacopo Andrea Giola Date: Tue, 3 Feb 2026 10:00:06 +0100 Subject: [PATCH 1/2] docs: update miactl docs --- docs/products/console/cli/miactl/20_setup.md | 10 ++-- .../console/cli/miactl/30_commands.md | 24 +++++---- .../console/cli/miactl/40_examples.md | 14 +++--- docs/products/console/cli/miactl/changelog.md | 50 ++++++++++++++++--- 4 files changed, 69 insertions(+), 29 deletions(-) diff --git a/docs/products/console/cli/miactl/20_setup.md b/docs/products/console/cli/miactl/20_setup.md index b69e36b40e..797c74319a 100644 --- a/docs/products/console/cli/miactl/20_setup.md +++ b/docs/products/console/cli/miactl/20_setup.md @@ -32,7 +32,7 @@ If you have [Golang] installed with a version >= 1.13 in your system and you hav install `miactl` like this: ```sh -go install github.com/mia-platform/miactl/cmd/miactl@v0.21.1 +go install github.com/mia-platform/miactl/cmd/miactl@v0.22.0 ``` Or like this if the `install` command is not available @@ -47,11 +47,11 @@ You can install `miactl` with the use of `curl` or `wget` and downloading the la choosing the correct platform and operating system: ```sh -curl -fsSL --proto '=https' --tlsv1.2 https://github.com/mia-platform/miactl/releases/download/v0.21.1/miactl-linux-amd64 -o /tmp/miactl +curl -fsSL --proto '=https' --tlsv1.2 https://github.com/mia-platform/miactl/releases/download/v0.22.0/miactl-linux-amd64 -o /tmp/miactl ``` ```sh -wget -q --https-only --secure-protocol=TLSv1_2 https://github.com/mia-platform/miactl/releases/download/v0.21.1/miactl-linux-amd64 -O /tmp/miactl +wget -q --https-only --secure-protocol=TLSv1_2 https://github.com/mia-platform/miactl/releases/download/v0.22.0/miactl-linux-amd64 -O /tmp/miactl ``` After you have downloaded the file you can validate it against the checksum you can find at this [url] running the @@ -79,7 +79,7 @@ sudo mv /tmp/miactl /usr/local/bin If you want to run the cli in its environment or you want to test the cli you can use the Docker image: ```sh -docker run ghcr.io/mia-platform/miactl:v0.21.1 miactl +docker run ghcr.io/mia-platform/miactl:v0.22.0 miactl ``` ### Windows @@ -178,7 +178,7 @@ only via APIs. [Homebrew]: https://brew.sh "The Missing Package Manager for macOS (or Linux)" [Golang]: https://go.dev "Build simple, secure, scalable systems with Go" -[url]: https://github.com/mia-platform/miactl/releases/download/v0.21.1/checksums.txt "miactl checksums" +[url]: https://github.com/mia-platform/miactl/releases/download/v0.22.0/checksums.txt "miactl checksums" [`bash-completion`]: https://github.com/scop/bash-completion "Programmable completion functions for bash" [`oh-my-zsh`]: https://ohmyz.sh "Oh My Zsh is a delightful, open source, community-driven framework for managing your Zsh configuration" diff --git a/docs/products/console/cli/miactl/30_commands.md b/docs/products/console/cli/miactl/30_commands.md index c157872bac..9a4c0baed7 100644 --- a/docs/products/console/cli/miactl/30_commands.md +++ b/docs/products/console/cli/miactl/30_commands.md @@ -482,12 +482,12 @@ Available flags for the command: ```json [ - { - "roleIds": ["developer"], - "disallowedRuleSet": [ - {"ruleId": "endpoint.security.edit"} - ] - } + { + "roleIds": ["developer"], + "disallowedRuleSet": [ + {"ruleId": "endpoint.security.edit"} + ] + } ] ``` @@ -865,7 +865,7 @@ By using the `routes.locationId` option, you can specify where the extension is you can create an extension shown on the Project runtime and activate it for the whole Company context. Such extension will be visible by all the Projects. -For further information checkout the [official documentation](/products/console/console-extensibility/activation.md). +For further information checkout the [official documentation](/products/console/console-extensibility/extension-activation). ::: Usage: @@ -878,7 +878,7 @@ Available flags for the command: - `--company-id` to set the ID of the desired Company - `--project-id` to set the ID of the desired project, if specified, the extension will be activated only for this - project only + project only - `--extension-id` **required** to set the ID of the extension ### deactivate @@ -900,7 +900,7 @@ Available flags for the command: - `--company-id` to set the ID of the desired Company - `--project-id` to set the ID of the desired project, if specified, the extension will be deactivated only for this - project only + project only - `--extension-id` **required** to set the ID of the extension. ### delete @@ -1021,6 +1021,8 @@ Available flags for the command: - `--company-id`, to set the ID of the desired Company - `--project-id`, to set the ID of the desired Project - `--environment`, to set the scope for the command +- `--waitJobCompletion`, (default `false`) to wait for the job completion before exiting +- `--waitJobTimeoutSeconds`, (default `600`, 10 minutes) to set a maximum wait timeout for the job completion ### logs @@ -1142,7 +1144,7 @@ The file can contain an image object with the following format: ```json "image": { - "localPath": "./someImage.png" + "localPath": "./someImage.png" } ``` @@ -1276,7 +1278,7 @@ The file can contain an image object with the following format: ```json "image": { - "localPath": "./someImage.png" + "localPath": "./someImage.png" } ``` diff --git a/docs/products/console/cli/miactl/40_examples.md b/docs/products/console/cli/miactl/40_examples.md index fcb0dd3cd7..5cc0e4e09a 100644 --- a/docs/products/console/cli/miactl/40_examples.md +++ b/docs/products/console/cli/miactl/40_examples.md @@ -78,12 +78,12 @@ miactl deploy development --no-semver --revision tags/v1.0.0 The commands are the same used above in the [Deploy Project](#deploy-project) section, but you need to use a _Service Account_ for that. -If you don't know how to create a _Service Account_, read the [dedicated documentation](/products/console/identity-and-access-management/manage-service-accounts.md). +If you don't know how to create a _Service Account_, read the [dedicated documentation](/products/console/identity-and-access-management/manage-service-accounts). -The _Service Account_ can be created with [two different authentication methods](/products/console/identity-and-access-management/manage-service-accounts.md#adding-a-service-account): +The _Service Account_ can be created with [two different authentication methods](/products/console/identity-and-access-management/manage-service-accounts#adding-a-service-account): -* _Client Secret Basic_: the service account authenticates by presenting its `client_id` and `client_secret`; -* _Private Key JWT_: the service account authenticates by signing a `JWT` (JSON Web Token) using its private key. +- _Client Secret Basic_: the service account authenticates by presenting its `client_id` and `client_secret`; +- _Private Key JWT_: the service account authenticates by signing a `JWT` (JSON Web Token) using its private key. After creating the _Service Account_, the first step to setup the `miactl` is **create an auth context**. With an _auth context_ you can choose how to be authenticated with the Mia-Platform APIs in all your different contexts @@ -91,13 +91,13 @@ you create with the `miactl`. Based on the authentication method of your _Service Account_, you can create the auth context with the following command: -* _Client Secret Basic_: +- _Client Secret Basic_: ```sh miactl context auth --client-id --client-secret ``` -* _Private Key JWT_: +- _Private Key JWT_: ```sh miactl context auth --jwt-json @@ -132,7 +132,7 @@ Finally, you can group the commands above and run them inside a pipeline, e.g. a # Insert that after your pipeline stages delivery: stage: deploy - image: ghcr.io/mia-platform/miactl:v0.21.1 + image: ghcr.io/mia-platform/miactl:v0.22.0 script: - miactl version diff --git a/docs/products/console/cli/miactl/changelog.md b/docs/products/console/cli/miactl/changelog.md index b462861b27..7f270cfca8 100644 --- a/docs/products/console/cli/miactl/changelog.md +++ b/docs/products/console/cli/miactl/changelog.md @@ -9,6 +9,42 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [v0.22.0] - 2026-02-03 + +### Changed + +- update go version to 1.25.6 +- update cobra to v1.10.2 +- update oauth2 to v0.34.0 +- update sync to v0.19.0 +- update text to v0.33.0 +- update kyaml to v0.21.0 + +### Added + +- `miactl deploy latest` for getting the latest successful deployment for a project in a specified environment +- `miactl runtime create job` has two additional new flags: + - `--waitJobCompletion` (default `false`) - if enabled, the `miactl` will wait for the job completion + - `--waitJobTimeoutSeconds` (default `600` seconds) - if `--waitJobCompletion` is enabled, the maximum wait timeout + for the job completion +- `miactl project version list` for listing available versions for a project +- `miactl project version create` for create a new version for a project + +### Fixed + +- value parsing from a triggered deploy in certain configurations + +### Removed + +- removed `miactl deploy ENVIRONMENT` deprecated command, use `miactl deploy trigger` instead that + is available since 0.15.x + +## [v0.21.2] - 2025-10-09 + +### Fixed + +- `miactl project describe` erroneously adding trailing slash to API endpoint for enhanced workflow projects + ## [v0.21.1] - 2025-09-26 ### Fixed @@ -47,7 +83,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - added `project describe` command. It supports `--revision`, `--version` flags for enhanced workflow projects and - `--branch`, `--tag` flags for standard workflow projects. + `--branch`, `--tag` flags for standard workflow projects. - added `project apply` command. It supports `--revision` flag as only enhanced workflow is supported for project apply ## [v0.19.0] - 2025-06-18 @@ -151,7 +187,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### BREAKING - updated `extension apply` command to support new request body schema. The older version of miactl will not be - compatible with the Console version upper or equal to 13.2.0. + compatible with the Console version upper or equal to 13.2.0. ## [v0.14.0] - 2024-07-25 @@ -229,7 +265,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### BREAKING -- move serviceaccount commads under `company iam add` +- move serviceaccount commands under `company iam add` ### Added @@ -254,7 +290,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed -- remove conflicting shortand flag `-v` from `miactl marketplace delete` command +- remove conflicting shorthand flag `-v` from `miactl marketplace delete` command - creation of basic auth service account ## [v0.10.0] - 2023-12-20 @@ -287,9 +323,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - update oauth2 to v0.15.0 - update exp to v0.0.0-20231127185646-65229373498e - modified `miactl marketplace delete` command to accept either the `objectId` or a `companyId`-`itemId`-`version` - tuple that identifies the item to be deleted. + tuple that identifies the item to be deleted. - modified `miactl marketplace get` command to accept either the `objectId` or a `companyId`-`itemId`-`version` tuple - that identifies the item to be retrieved. + that identifies the item to be retrieved. ### Fixed @@ -421,6 +457,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - create cli sdk - create cli renderer +[v0.22.0]: https://github.com/mia-platform/miactl/compare/v0.21.2...v0.22.0 +[v0.21.2]: https://github.com/mia-platform/miactl/compare/v0.21.1...v0.21.2 [v0.21.1]: https://github.com/mia-platform/miactl/compare/v0.21.0...v0.21.1 [v0.21.0]: https://github.com/mia-platform/miactl/compare/v0.20.0...v0.21.0 [v0.20.0]: https://github.com/mia-platform/miactl/compare/v0.19.0...v0.20.0 From 8aa66b0c9f3e3355b431bd34f82253894e390357 Mon Sep 17 00:00:00 2001 From: Jacopo Andrea Giola Date: Tue, 3 Feb 2026 12:04:30 +0100 Subject: [PATCH 2/2] docs: fix broken link in miactl docs --- docs/products/console/cli/miactl/30_commands.md | 2 +- docs/products/console/cli/miactl/40_examples.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/products/console/cli/miactl/30_commands.md b/docs/products/console/cli/miactl/30_commands.md index 9a4c0baed7..c71e2323d0 100644 --- a/docs/products/console/cli/miactl/30_commands.md +++ b/docs/products/console/cli/miactl/30_commands.md @@ -865,7 +865,7 @@ By using the `routes.locationId` option, you can specify where the extension is you can create an extension shown on the Project runtime and activate it for the whole Company context. Such extension will be visible by all the Projects. -For further information checkout the [official documentation](/products/console/console-extensibility/extension-activation). +For further information checkout the [official documentation](/products/console/console-extensibility/activation.md). ::: Usage: diff --git a/docs/products/console/cli/miactl/40_examples.md b/docs/products/console/cli/miactl/40_examples.md index 5cc0e4e09a..3a6c2c03de 100644 --- a/docs/products/console/cli/miactl/40_examples.md +++ b/docs/products/console/cli/miactl/40_examples.md @@ -78,9 +78,9 @@ miactl deploy development --no-semver --revision tags/v1.0.0 The commands are the same used above in the [Deploy Project](#deploy-project) section, but you need to use a _Service Account_ for that. -If you don't know how to create a _Service Account_, read the [dedicated documentation](/products/console/identity-and-access-management/manage-service-accounts). +If you don't know how to create a _Service Account_, read the [dedicated documentation](/products/console/identity-and-access-management/manage-service-accounts.md). -The _Service Account_ can be created with [two different authentication methods](/products/console/identity-and-access-management/manage-service-accounts#adding-a-service-account): +The _Service Account_ can be created with [two different authentication methods](/products/console/identity-and-access-management/manage-service-accounts.md#service-account-authentication): - _Client Secret Basic_: the service account authenticates by presenting its `client_id` and `client_secret`; - _Private Key JWT_: the service account authenticates by signing a `JWT` (JSON Web Token) using its private key.