Skip to content

Commit

Permalink
docs: Rename to --config-file in remaining docs (kyma-project#78)
Browse files Browse the repository at this point in the history
docs: Rename to '--config-file' in remaining docs
  • Loading branch information
c-pius authored Oct 22, 2024
1 parent 09f42c8 commit cc4d01d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion cmd/modulectl/create/example.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Build a simple module and push it to a remote registry
modulectl create --module-config-file=/path/to/module-config-file --registry http://localhost:5001/unsigned --insecure
modulectl create --config-file=/path/to/module-config-file --registry http://localhost:5001/unsigned --insecure
2 changes: 1 addition & 1 deletion docs/gen-docs/modulectl_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ modulectl create [--config-file MODULE_CONFIG_FILE] [--registry MODULE_REGISTRY]

```bash
Build a simple module and push it to a remote registry
modulectl create --module-config-file=/path/to/module-config-file --registry http://localhost:5001/unsigned --insecure
modulectl create --config-file=/path/to/module-config-file --registry http://localhost:5001/unsigned --insecure
```

## Flags
Expand Down
10 changes: 5 additions & 5 deletions tests/e2e/create/create_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ var _ = Describe("Test 'create' command", Ordered, func() {

Context("Given 'modulectl create' command", func() {
var cmd createCmd
It("When invoked with '--module-config-file' using file with missing name", func() {
It("When invoked with '--config-file' using file with missing name", func() {
cmd = createCmd{
moduleConfigFile: missingNameConfig,
}
Expand All @@ -53,7 +53,7 @@ var _ = Describe("Test 'create' command", Ordered, func() {

Context("Given 'modulectl create' command", func() {
var cmd createCmd
It("When invoked with '--module-config-file' using file with missing channel", func() {
It("When invoked with '--config-file' using file with missing channel", func() {
cmd = createCmd{
moduleConfigFile: missingChannelConfig,
}
Expand All @@ -67,7 +67,7 @@ var _ = Describe("Test 'create' command", Ordered, func() {

Context("Given 'modulectl create' command", func() {
var cmd createCmd
It("When invoked with '--module-config-file' using file with missing version", func() {
It("When invoked with '--config-file' using file with missing version", func() {
cmd = createCmd{
moduleConfigFile: missingVersionConfig,
}
Expand All @@ -81,7 +81,7 @@ var _ = Describe("Test 'create' command", Ordered, func() {

Context("Given 'modulectl create' command", func() {
var cmd createCmd
It("When invoked with '--module-config-file' using file with missing manifest", func() {
It("When invoked with '--config-file' using file with missing manifest", func() {
cmd = createCmd{
moduleConfigFile: missingManifestConfig,
}
Expand Down Expand Up @@ -165,7 +165,7 @@ var _ = Describe("Test 'create' command", Ordered, func() {

Context("Given 'modulectl create' command", func() {
var cmd createCmd
It("When invoked with '--module-config-file' using valid file", func() {
It("When invoked with '--config-file' using valid file", func() {
cmd = createCmd{
moduleConfigFile: minimalConfig,
}
Expand Down

0 comments on commit cc4d01d

Please sign in to comment.