Skip to content

Commit da2e724

Browse files
committed
build!: rename the CLI tool to dsm
CLI tool is renamed from `dtm` to `dsm`. Documentation is updated, too. BREAKING CHANGE: the CLI tool is renamed to `dsm`.
1 parent f72ce88 commit da2e724

File tree

5 files changed

+12
-8
lines changed

5 files changed

+12
-8
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
*.dylib
99

1010
# build
11-
/dtm
11+
/dsm
1212

1313
# Test binary, build with `go test -c`
1414
*.test

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ build:
33
go build -buildmode=plugin -trimpath -gcflags="all=-N -l" -o plugins/githubactions_0.0.1.so ./cmd/githubactions/
44
go build -buildmode=plugin -trimpath -gcflags="all=-N -l" -o plugins/argocd_0.0.1.so ./cmd/argocd/
55
go build -buildmode=plugin -trimpath -gcflags="all=-N -l" -o plugins/argocdapp_0.0.1.so ./cmd/argocdapp/
6-
go build -trimpath -gcflags="all=-N -l" -o dtm ./cmd/devstream/
6+
go build -trimpath -gcflags="all=-N -l" -o dsm ./cmd/devstream/

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
## DevStream, What Is It Anyway?
1616

17-
DevStream is an open-source DevOps tool manager (DTM).
17+
DevStream is an open-source DevOps tool manager.
1818

1919
Imagine you are in a new project. Before writing the first line of code, you would have to figure out the tools needed in the whole Software Development Life Cycle (SDLC). You would probably need the following pieces:
2020

@@ -35,7 +35,7 @@ And, there are multiple challenges in creating YOUR ideal SDLC workflow:
3535

3636
To be fair, there are a few integrated products out there that may contain everything you might need, but they might not suit your specific requirements perfectly. So, the chance is, you will still want to go out and do your research, find the best pieces for you, and integrate them. And, it would be a lot of operational overhead if all you had to do all day was install and uninstall and integrate things.
3737

38-
You probably have already seen where we are going with this, and you are right: DevStream, an open-source DevOps tool manager (DTM), aims to be the solution here.
38+
You probably have already seen where we are going with this, and you are right: DevStream, an open-source DevOps tool manager, aims to be the solution here.
3939

4040
Think of the Linux kernel V.S. different distributions. Different distros offer different packages so that you can always choose the best for your need.
4141

@@ -67,8 +67,10 @@ See [examples/config.yaml](./examples/config.yaml).
6767

6868
## Run
6969

70+
The CLI tool is named `dsm`, which is short for DevStream:
71+
7072
```bash
71-
./dtm install -f examples/config.yaml
73+
./dsm install -f examples/config.yaml
7274
```
7375

7476
## Contribute

cmd/devstream/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ var (
1010
configFile string
1111

1212
rootCMD = &cobra.Command{
13-
Use: "dtm",
13+
Use: "dsm",
1414
Short: "DevStream is an open-source DevOps tool manager",
1515
Long: `DevStream is an open-source DevOps tool manager`,
1616
}

docs/architecture.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ The following diagram shows an approximation of how DevStream executes a user co
1010

1111
## CLI (The `devstream` Package)
1212

13-
Every time a user runs the `dtm` program, the execution transfers immediately into one of the "command" implementations in the [`devstream`](https://github.com/merico-dev/stream/tree/main/cmd/devstream) package, in which folder all commands' definitions reside. Then, each command calls the corresponding package under [`internal/pkg`](https://github.com/merico-dev/stream/tree/main/internal/pkg).
13+
For simplicity, the CLI is named `dsm` instead of the full name DevStream.
1414

15-
The flow illustrated above applies to the main DevStream commands like `dtm install`, `dtm uninstall` (_TODO_), and `dtm reinstall` (_TODO_). For these commands, the role of the command is to parse all the config, load each plugin, and call the [predefined interface](https://github.com/merico-dev/stream/blob/main/internal/pkg/plugin/plugin.go#L12).
15+
Every time a user runs the `dsm` program, the execution transfers immediately into one of the "command" implementations in the [`devstream`](https://github.com/merico-dev/stream/tree/main/cmd/devstream) package, in which folder all commands' definitions reside. Then, each command calls the corresponding package under [`internal/pkg`](https://github.com/merico-dev/stream/tree/main/internal/pkg).
16+
17+
The flow illustrated above applies to the main DevStream commands like `dsm install`, `dsm uninstall` (_TODO_), and `dsm reinstall` (_TODO_). For these commands, the role of the command is to parse all the config, load each plugin, and call the [predefined interface](https://github.com/merico-dev/stream/blob/main/internal/pkg/plugin/plugin.go#L12).
1618

1719
## Configuration Loader
1820

0 commit comments

Comments
 (0)