Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- [Using profiles](#using-profiles)
- [Pull command](#pull-command)
- [Push command](#push-command)
- [Using Git Profiles (beta)](#using-git-profiles-beta)
- [Using Git Profiles](#using-git-profiles)
- [Using content-cli inside Studio](#using-content-cli-inside-studio)
- [Pull/Push packages from/to Studio](#pullpush-packages-fromto-studio)
- [Pull package for Celonis Marketplace](#pull-package-for-celonis-marketplace)
Expand Down Expand Up @@ -229,7 +229,7 @@ content-cli push ctp -p my-profile-name --file path-to-ctp-file --password ctp-f
content-cli push ctp -p my-profile-name --file path-to-ctp-file --password ctp-file-password --pushDataModels
```

### Using Git Profiles (beta)
### Using Git Profiles

In addition to Celonis profiles, you can configure **Git profiles** to interact with GitHub repositories directly from Content CLI.
This enables workflows where you export packages to a Git branch, collaborate via Git pull requests, and then import reviewed content back into Celonis.
Expand Down Expand Up @@ -585,10 +585,10 @@ exported_package_random_uuid/
├─ package_keyN-version.zip
```

Additionally, the following **Git options** are available (**beta**):
Additionally, the following **Git options** are available:
- ```--gitProfile <gitProfileName>``` – specifies the Git profile to use for exporting directly to a repository.
If not specified, the default profile will be used. ⚠️ *(beta: may change or be removed in future releases)*
- ```--gitBranch <branchName>``` – specifies the branch in the Github repository where the export will be pushed. ⚠️ *(beta: may change or be removed in future releases)*
If not specified, the default profile will be used.
- ```--gitBranch <branchName>``` – specifies the branch in the Github repository where the export will be pushed.

Example exporting to Git:
```
Expand Down Expand Up @@ -623,10 +623,10 @@ When packages with the same keys exist in the target team, the --overwrite optio
content-cli config import -p <sourceProfile> -f <file path> --overwrite
```

Additionally, the following **Git options** are available (**beta**):
Additionally, the following **Git options** are available:
- ```--gitProfile <gitProfileName>``` – specifies the Git profile to use for importing directly from a repository.
If not specified, the default profile will be used. ⚠️ *(beta: may change or be removed in future releases)*
- ```--gitBranch <branchName>``` – specifies the branch in the Github repository from which to import. ⚠️ *(beta: may change or be removed in future releases)*
If not specified, the default profile will be used.
- ```--gitBranch <branchName>``` – specifies the branch in the Github repository from which to import.

Example importing from Git:
```
Expand Down
8 changes: 4 additions & 4 deletions src/commands/configuration-management/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ class Module extends IModule {
.option("--keysByVersion <keysByVersion...>", "Keys of packages to export by version")
.option("--withDependencies", "Include variables and dependencies", "")
.option("--unzip", "Unzip the exported file", "")
.betaOption("--gitProfile <gitProfile>", "Git profile which you want to use for the Git operations")
.betaOption("--gitBranch <gitBranch>", "Git branch in which you want to push the exported file")
.option("--gitProfile <gitProfile>", "Git profile which you want to use for the Git operations")
.option("--gitBranch <gitBranch>", "Git branch in which you want to push the exported file")
.action(this.batchExportPackages);

const metadataCommand = configCommand.command("metadata")
Expand All @@ -48,8 +48,8 @@ class Module extends IModule {
configCommand.command("import")
.description("Command to import package configs")
.option("--overwrite", "Flag to allow overwriting of packages")
.betaOption("--gitProfile <gitProfile>", "Git profile which you want to use for the Git operations")
.betaOption("--gitBranch <gitBranch>", "Git branch from which you want to pull the exported file and import")
.option("--gitProfile <gitProfile>", "Git profile which you want to use for the Git operations")
.option("--gitBranch <gitBranch>", "Git branch from which you want to pull the exported file and import")
.option("-f, --file <file>", "Exported packages file (relative path)")
.option("-d, --directory <directory>", "Exported packages directory (relative path)")
.action(this.batchImportPackages);
Expand Down
5 changes: 0 additions & 5 deletions src/commands/git-profile/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,22 @@ class Module extends IModule {

public register(context: Context, configurator: Configurator): void {
const gitCommand = configurator.command("git")
.beta()
.description("Commands related to Git settings");

const gitProfileCommand = gitCommand.command("profile")
.beta()
.description("Manage Git profiles required to use git-related operations.");

gitProfileCommand.command("list")
.description("Command to list all stored Git profiles")
.beta()
.action(this.listProfiles);

gitProfileCommand.command("create")
.description("Command to create a new Git profile")
.option("--setAsDefault", "Set this Git profile as default")
.beta()
.action(this.createProfile);

gitProfileCommand.command("default <profile>")
.description("Command to set a Git profile as default")
.beta()
.action(this.defaultProfile);
}

Expand Down