[COMPASS-6084] Include a dummy global configuration file in packages Created: 31/Aug/22  Updated: 29/Oct/23  Resolved: 28/Nov/22

Status: Closed
Project: Compass
Component/s: Packaging
Affects Version/s: None
Fix Version/s: 1.35.0

Type: Task Priority: Major - P3
Reporter: Anna Henningsen Assignee: Anna Henningsen
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
depends on COMPASS-6071 Implement global config file parser Closed
Documented
Epic Link: COMPASS-5816
Documentation Changes: Needed
Documentation Changes Summary:

Compass adds a --show-example-config command line flag that will make Compass print out the contents of an example configuration file for Compass. The --help output also provides a hint for this behavior.

Sprint: Iteration Porpoise

 Comments   
Comment by Githook User [ 02/Dec/22 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna.henningsen@mongodb.com', 'username': 'addaleax'}

Message: feat: add --show-example-config flag COMPASS-6084 (#3834)

The original config file suggested including a file in the packages
themselves. However, this is hard for a number of reasons; for example,
our .deb and .rpm generators do not provide options for specifying
configuration files, and if they did, config files would conflict
between the different variants of Compass. For the .zip distribution,
we ship the Compass executable at the top level of the .zip, meaning
that it is impossible to actually write to the path where Compass
expects the configuration file just by unpacking the .zip.

As a lightweight alternative, Compass now supports a new
`--show-example-config` command line flag, and refers to it, together
with a full command showing its usage, in the `--help` output.
Branch: revert-3723-revert-3709-compass-6170-remove-pipeline-from-text
https://github.com/mongodb-js/compass/commit/aaccfd472a61651f2cd223e08a772916adea0d39

Comment by Githook User [ 01/Dec/22 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna.henningsen@mongodb.com', 'username': 'addaleax'}

Message: feat: add --show-example-config flag COMPASS-6084 (#3834)

The original config file suggested including a file in the packages
themselves. However, this is hard for a number of reasons; for example,
our .deb and .rpm generators do not provide options for specifying
configuration files, and if they did, config files would conflict
between the different variants of Compass. For the .zip distribution,
we ship the Compass executable at the top level of the .zip, meaning
that it is impossible to actually write to the path where Compass
expects the configuration file just by unpacking the .zip.

As a lightweight alternative, Compass now supports a new
`--show-example-config` command line flag, and refers to it, together
with a full command showing its usage, in the `--help` output.
Branch: update-compass-shell-to-shared-config
https://github.com/mongodb-js/compass/commit/aaccfd472a61651f2cd223e08a772916adea0d39

Comment by Githook User [ 30/Nov/22 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna.henningsen@mongodb.com', 'username': 'addaleax'}

Message: feat: add --show-example-config flag COMPASS-6084 (#3834)

The original config file suggested including a file in the packages
themselves. However, this is hard for a number of reasons; for example,
our .deb and .rpm generators do not provide options for specifying
configuration files, and if they did, config files would conflict
between the different variants of Compass. For the .zip distribution,
we ship the Compass executable at the top level of the .zip, meaning
that it is impossible to actually write to the path where Compass
expects the configuration file just by unpacking the .zip.

As a lightweight alternative, Compass now supports a new
`--show-example-config` command line flag, and refers to it, together
with a full command showing its usage, in the `--help` output.
Branch: update-lg-again
https://github.com/mongodb-js/compass/commit/aaccfd472a61651f2cd223e08a772916adea0d39

Comment by Githook User [ 30/Nov/22 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna.henningsen@mongodb.com', 'username': 'addaleax'}

Message: feat: add --show-example-config flag COMPASS-6084 (#3834)

The original config file suggested including a file in the packages
themselves. However, this is hard for a number of reasons; for example,
our .deb and .rpm generators do not provide options for specifying
configuration files, and if they did, config files would conflict
between the different variants of Compass. For the .zip distribution,
we ship the Compass executable at the top level of the .zip, meaning
that it is impossible to actually write to the path where Compass
expects the configuration file just by unpacking the .zip.

As a lightweight alternative, Compass now supports a new
`--show-example-config` command line flag, and refers to it, together
with a full command showing its usage, in the `--help` output.
Branch: COMPASS-6325-fix-settings-modal-height-and-categories
https://github.com/mongodb-js/compass/commit/aaccfd472a61651f2cd223e08a772916adea0d39

Comment by Githook User [ 30/Nov/22 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna.henningsen@mongodb.com', 'username': 'addaleax'}

Message: feat: add --show-example-config flag COMPASS-6084 (#3834)

The original config file suggested including a file in the packages
themselves. However, this is hard for a number of reasons; for example,
our .deb and .rpm generators do not provide options for specifying
configuration files, and if they did, config files would conflict
between the different variants of Compass. For the .zip distribution,
we ship the Compass executable at the top level of the .zip, meaning
that it is impossible to actually write to the path where Compass
expects the configuration file just by unpacking the .zip.

As a lightweight alternative, Compass now supports a new
`--show-example-config` command line flag, and refers to it, together
with a full command showing its usage, in the `--help` output.
Branch: add-script-for-generating-readme-package-descriptions
https://github.com/mongodb-js/compass/commit/aaccfd472a61651f2cd223e08a772916adea0d39

Comment by Githook User [ 28/Nov/22 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna.henningsen@mongodb.com', 'username': 'addaleax'}

Message: feat: add --show-example-config flag COMPASS-6084 (#3834)

The original config file suggested including a file in the packages
themselves. However, this is hard for a number of reasons; for example,
our .deb and .rpm generators do not provide options for specifying
configuration files, and if they did, config files would conflict
between the different variants of Compass. For the .zip distribution,
we ship the Compass executable at the top level of the .zip, meaning
that it is impossible to actually write to the path where Compass
expects the configuration file just by unpacking the .zip.

As a lightweight alternative, Compass now supports a new
`--show-example-config` command line flag, and refers to it, together
with a full command showing its usage, in the `--help` output.
Branch: no-duplicate-stages
https://github.com/mongodb-js/compass/commit/aaccfd472a61651f2cd223e08a772916adea0d39

Comment by Githook User [ 28/Nov/22 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna.henningsen@mongodb.com', 'username': 'addaleax'}

Message: feat: add --show-example-config flag COMPASS-6084 (#3834)

The original config file suggested including a file in the packages
themselves. However, this is hard for a number of reasons; for example,
our .deb and .rpm generators do not provide options for specifying
configuration files, and if they did, config files would conflict
between the different variants of Compass. For the .zip distribution,
we ship the Compass executable at the top level of the .zip, meaning
that it is impossible to actually write to the path where Compass
expects the configuration file just by unpacking the .zip.

As a lightweight alternative, Compass now supports a new
`--show-example-config` command line flag, and refers to it, together
with a full command showing its usage, in the `--help` output.
Branch: update-react-tooltip-usage-to-lg
https://github.com/mongodb-js/compass/commit/aaccfd472a61651f2cd223e08a772916adea0d39

Comment by Githook User [ 28/Nov/22 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna.henningsen@mongodb.com', 'username': 'addaleax'}

Message: feat: add --show-example-config flag COMPASS-6084 (#3834)

The original config file suggested including a file in the packages
themselves. However, this is hard for a number of reasons; for example,
our .deb and .rpm generators do not provide options for specifying
configuration files, and if they did, config files would conflict
between the different variants of Compass. For the .zip distribution,
we ship the Compass executable at the top level of the .zip, meaning
that it is impossible to actually write to the path where Compass
expects the configuration file just by unpacking the .zip.

As a lightweight alternative, Compass now supports a new
`--show-example-config` command line flag, and refers to it, together
with a full command showing its usage, in the `--help` output.
Branch: main
https://github.com/mongodb-js/compass/commit/aaccfd472a61651f2cd223e08a772916adea0d39

Comment by Githook User [ 28/Nov/22 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna.henningsen@mongodb.com', 'username': 'addaleax'}

Message: feat: add --show-example-config flag COMPASS-6084

The original config file suggested including a file in the packages
themselves. However, this is hard for a number of reasons; for example,
our .deb and .rpm generators do not provide options for specifying
configuration files, and if they did, config files would conflict
between the different variants of Compass. For the .zip distribution,
we ship the Compass executable at the top level of the .zip, meaning
that it is impossible to actually write to the path where Compass
expects the configuration file just by unpacking the .zip.

As a lightweight alternative, Compass now supports a new
`--show-example-config` command line flag, and refers to it, together
with a full command showing its usage, in the `--help` output.
Branch: 6084-dev
https://github.com/mongodb-js/compass/commit/5495c011bbb6bf6928563491c54e491f36c4e0cc

Generated at Wed Feb 07 22:41:52 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.