Skip to content

chore: make the kpm cli deprecated #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 30, 2024
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
31 changes: 31 additions & 0 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,37 @@
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen">
</p>

# 注意 !

KPM CLI 将在 v0.8.0 版本后被弃用,并且 KPM CLI 将被 KCL CLI 替代 - https://github.com/kcl-lang/cli.

受到影响的部分如下所示:

```
kpm
├── pkg
│ ├── api
│ ├── client
│ ├── cmd # KPM CLI 将在 v0.8.0 版本后被弃用.
│ ├── constants
│ ├── env
│ ├── errors
│ ├── git
│ ├── oci
│ ├── opt
│ ├── package
│ ├── reporter
│ ├── runner
│ ├── semver
│ ├── settings
│ ├── utils
│ └── version
├── scripts
├── test
│ └── e2e # KPM CLI 的 e2e 测试将在 v0.8.0 版本后被弃用.
├── ......
```

## 介绍

`kpm` 是 KCL 包管理器。`kpm` 会下载您的 KCL 包的依赖项、编译您的 KCL 包、制作可分发的包并将其上传到 KCL 包的仓库中。
Expand Down
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,37 @@
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen">
</p>

# NOTE !

The KPM CLI will be deprecated after v0.8.0, and the KPM CLI will be replaced by the KCL CLI - https://github.com/kcl-lang/cli.

The affected parts are shown below:

```
kpm
├── pkg
│ ├── api
│ ├── client
│ ├── cmd # The KPM CLI will deprecated after v0.8.0.
│ ├── constants
│ ├── env
│ ├── errors
│ ├── git
│ ├── oci
│ ├── opt
│ ├── package
│ ├── reporter
│ ├── runner
│ ├── semver
│ ├── settings
│ ├── utils
│ └── version
├── scripts
├── test
│ └── e2e # The e2e test for KPM CLI will deprecated after v0.8.0.
├── ......
```

## Introduction

`kpm` is the KCL package manager. `kpm` downloads your KCL package's dependencies, compiles your KCL packages, makes packages, and uploads them to the kcl package registry.
Expand Down
2 changes: 2 additions & 0 deletions pkg/cmd/cmd_add.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright 2023 The KCL Authors. All rights reserved.
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package cmd

Expand Down
4 changes: 4 additions & 0 deletions pkg/cmd/cmd_flags.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
// Copyright 2023 The KCL Authors. All rights reserved.
// This file provides all the flags in the kpm cli.
//
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package cmd

const FLAG_INPUT = "input"
Expand Down
2 changes: 2 additions & 0 deletions pkg/cmd/cmd_import.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright 2023 The KCL Authors. All rights reserved.
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package cmd

Expand Down
2 changes: 2 additions & 0 deletions pkg/cmd/cmd_init.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright 2023 The KCL Authors. All rights reserved.
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package cmd

Expand Down
2 changes: 2 additions & 0 deletions pkg/cmd/cmd_login.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright 2023 The KCL Authors. All rights reserved.
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package cmd

Expand Down
2 changes: 2 additions & 0 deletions pkg/cmd/cmd_logout.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright 2023 The KCL Authors. All rights reserved.
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package cmd

Expand Down
2 changes: 2 additions & 0 deletions pkg/cmd/cmd_metadata.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright 2023 The KCL Authors. All rights reserved.
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package cmd

Expand Down
2 changes: 2 additions & 0 deletions pkg/cmd/cmd_pkg.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright 2023 The KCL Authors. All rights reserved.
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package cmd

Expand Down
2 changes: 2 additions & 0 deletions pkg/cmd/cmd_pull.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright 2023 The KCL Authors. All rights reserved.
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package cmd

Expand Down
2 changes: 2 additions & 0 deletions pkg/cmd/cmd_push.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright 2023 The KCL Authors. All rights reserved.
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package cmd

Expand Down
2 changes: 2 additions & 0 deletions pkg/cmd/cmd_push_test.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright 2023 The KCL Authors. All rights reserved.
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package cmd

Expand Down
2 changes: 2 additions & 0 deletions pkg/cmd/cmd_run.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright 2023 The KCL Authors. All rights reserved.
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package cmd

Expand Down
2 changes: 2 additions & 0 deletions pkg/cmd/cmd_update.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright 2023 The KCL Authors. All rights reserved.
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package cmd

Expand Down
2 changes: 2 additions & 0 deletions pkg/version/version.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright 2022 The KCL Authors. All rights reserved.
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.

package version

Expand Down
3 changes: 3 additions & 0 deletions pkg/version/version_test.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
// Deprecated: The entire contents of this file will be deprecated.
// Please use the kcl cli - https://github.com/kcl-lang/cli.
package version

import "testing"

// Deprecated: This function will be removed in a future version.
func TestGetVersionInStr(t *testing.T) {
tests := []struct {
name string
Expand Down