You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Please fill out the information below to help speed up the review process
8
8
and getting you pull request merged!
@@ -32,9 +32,9 @@ We're here to help! This is simply a reminder of what we are going to look for b
32
32
33
33
-[ ] I have signed the [MongoDB CLA](https://www.mongodb.com/legal/contributor-agreement)
34
34
-[ ] I have added tests that prove my fix is effective or that my feature works
35
-
-[ ] I have added any necessary documentation in document requirements section listed in [CONTRIBUTING.md](https://github.com/mongodb/mongodb-atlas-cli/blob/master/CONTRIBUTING.md) (if appropriate)
35
+
-[ ] I have added any necessary documentation in document requirements section listed in [CONTRIBUTING.md](https://github.com/mongodb/mongodb-cli/blob/master/CONTRIBUTING.md) (if appropriate)
36
36
-[ ] I have addressed the @mongodb/docs-cloud-team comments (if appropriate)
37
-
-[ ] I have updated [test/README.md](https://github.com/mongodb/mongodb-atlas-cli/blob/master/test/README.md) (if an e2e test has been added)
37
+
-[ ] I have updated [test/README.md](https://github.com/mongodb/mongodb-cli/blob/master/test/README.md) (if an e2e test has been added)
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ please head over to our [feedback page](https://feedback.mongodb.com/forums/9243
15
15
16
16
## Reporting Issues
17
17
18
-
Please create a [GitHub issue](https://github.com/mongodb/mongodb-atlas-cli/issues/new?assignees=&labels=&template=bug_report.md) describing the kind of problem you're facing
18
+
Please create a [GitHub issue](https://github.com/mongodb/mongodb-cli/issues/new?assignees=&labels=&template=bug_report.md) describing the kind of problem you're facing
19
19
with as much detail as possible, including things like operating system or anything else may be relevant to the issue.
20
20
21
21
## Auto-close Stale Issues and Pull Requests
@@ -41,7 +41,7 @@ To make the contribution process as seamless as possible, we ask for the followi
41
41
- Have test cases for the new code. If you have questions about how to do this, please ask in your pull request or check the [Building and Testing](#building-and-testing) section.
42
42
- Run `make fmt`.
43
43
- Add documentation if you are adding new features or changing functionality.
44
-
- Confirm that `make check` succeeds. [GitHub Actions](https://github.com/mongodb/mongodb-atlas-cli/actions).
44
+
- Confirm that `make check` succeeds. [GitHub Actions](https://github.com/mongodb/mongodb-cli/actions).
45
45
46
46
### Development Setup
47
47
@@ -129,12 +129,12 @@ Depending on the feature you are building you might choose to:
129
129
For a command group, we need to create new cobra root command.
130
130
This command aggregates a number of subcommands that can perform network requests and return results
131
131
132
-
For example [teams](https://github.com/mongodb/mongodb-atlas-cli/tree/220c6c73f346f5c711a1c772b17f93a6811efc69/internal/cli/atlas/teams)
132
+
For example [teams](https://github.com/mongodb/mongodb-cli/tree/220c6c73f346f5c711a1c772b17f93a6811efc69/internal/cli/atlas/teams)
133
133
command root provides the main execution point for `atlas teams` with subcommands like `atlas teams list`
134
134
135
135
Root command links to a number of child commands. Atlas CLI provides a number of patterns for child commands depending on the type of operation performed.
136
136
Each new feature might cover typical commands like `list` and `describe` along with dedicated actions.
137
-
For example [list command](https://github.com/mongodb/mongodb-atlas-cli/blob/220c6c73f346f5c711a1c772b17f93a6811efc69/internal/cli/atlas/teams/list.go).
137
+
For example [list command](https://github.com/mongodb/mongodb-cli/blob/220c6c73f346f5c711a1c772b17f93a6811efc69/internal/cli/atlas/teams/list.go).
138
138
It is normal to duplicate existing commands and edit descriptions and methods for your own needs.
139
139
140
140
Additionally, after adding new command we need to add it to the main CLI root command.
@@ -178,7 +178,7 @@ Flags are a way to modify the command, also may be called "options". Flags alway
178
178
-`--booleanFlag`: this flag represents a boolean and it sets the related variable to true when the flag is used, false otherwise. Example: `--force`
179
179
-`--flagName value1,value2,..,valueN`: you will also find flags that accept a list of values. This type of flag can be very useful to represent data structures as `--role roleName1@db,roleName2@db`, `--privilege [email protected],[email protected]`, or `--key field:type`.
180
180
As shown in the examples, the standard format used to represent data structures consists of splitting the first value with the second one by at sign `@` or colon `:`, and the second value with the third one by a full stop `.`.
181
-
We recommend using configuration files for complex data structures that require more than three values. For an example of configuration files, see [mongocli atlas cluster create](https://github.com/mongodb/mongodb-atlas-cli/blob/f2e6d661a3eb2cfcf9baab5f9e0b1c0f872b8c14/internal/cli/atlas/clusters/create.go#L235).
181
+
We recommend using configuration files for complex data structures that require more than three values. For an example of configuration files, see [mongocli atlas cluster create](https://github.com/mongodb/mongodb-cli/blob/f2e6d661a3eb2cfcf9baab5f9e0b1c0f872b8c14/internal/cli/atlas/clusters/create.go#L235).
Copy file name to clipboardExpand all lines: RELEASING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,15 +18,15 @@ Use the instructions bellow as a fallback.
18
18
19
19
Package Managers are published after a stable release happens, in which binaries are stored in github releases and also uploaded to our download center (https://www.mongodb.com/try/download/atlascli and https://www.mongodb.com/try/download/mongocli).
20
20
21
-
*[Chocolatey](http://chocolatey.org) release is triggered in https://github.com/mongodb-forks/chocolatey-packages/, the Github Action will trigger every weekday at 4pm (UTC) to check if there are any new releases in https://github.com/mongodb/mongodb-atlas-cli/releases/.
21
+
*[Chocolatey](http://chocolatey.org) release is triggered in https://github.com/mongodb-forks/chocolatey-packages/, the Github Action will trigger every weekday at 4pm (UTC) to check if there are any new releases in https://github.com/mongodb/mongodb-cli/releases/.
22
22
23
23
*[Homebrew](http://brew.sh/) release is triggered in https://github.com/Homebrew/homebrew-core/, which is not maintained by MongoDB rather by homebrew community.
24
24
25
25
* Yum and Apt are handled internally via evergreen tasks `push_stable_atlascli_generate` and `push_stable_mongocli_generate`.
26
26
27
27
## Docker Image
28
28
Our Docker image release for AtlasCLI is managed through the [docker-release.yml](.github/workflows/docker-release.yml) workflow. This process is automated to run daily, ensuring the latest versions of the image dependencies are updated.
The AtlasCLI Docker image is built from the ([Dockerfile](Dockerfile)) and tagged in three ways: `latest`, `vX.Y.Z` (reflecting the latest release version, e.g., `v1.22.0`), and `vX.Y.Z-date` (adding the current date, e.g., `v1.22.0-2024-01-01`). This image is initially published to a staging registry to prepare for signature in the next step.
@@ -55,7 +55,7 @@ This will do the following things:
55
55
1. Tag a new version, ie: `git tag -a -s atlascli/v1.0.0 -m "atlascli/v1.0.0"`
56
56
2. Publish the new tag, ie `git push origin atlascli/v1.0.0`
57
57
3. The [evergreen](build/ci/release.yml) release task will run after a tag event from master.
58
-
4. If everything goes smoothly the release will be published in the [releases page](https://github.com/mongodb/mongodb-atlas-cli/releases), and [download center](https://www.mongodb.com/try/download/mongocli).
58
+
4. If everything goes smoothly the release will be published in the [releases page](https://github.com/mongodb/mongodb-cli/releases), and [download center](https://www.mongodb.com/try/download/mongocli).
0 commit comments