Docs about 'scm_to_conandata' #1522
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 tasks
memsharded
approved these changes
Jan 14, 2020
| @@ -15,7 +15,7 @@ The typical location of the **conan.conf** file is the directory ``~/.conan/``: | |||
| print_run_commands = False # environment CONAN_PRINT_RUN_COMMANDS | |||
|
|
|||
| [general] | |||
| default_profile = default | |||
| default_profile = %s | |||
There was a problem hiding this comment.
%s? Not sure what is this change
danimtb
reviewed
Jan 15, 2020
creating_packages/package_repo.rst
Outdated
| the "resolved" URL and commit. | ||
|
|
||
| * If ``scm_to_conandata`` is activated, the value of these fields (except ``username`` and ``password``) will | ||
| be stored in the ``conandata.yml`` file that will be automatically exported with the recipe. |
There was a problem hiding this comment.
Link to the conandata.yml reference
creating_packages/package_repo.rst
Outdated
| * If ``scm_to_conandata`` is activated, the value of these fields (except ``username`` and ``password``) will | ||
| be stored in the ``conandata.yml`` file that will be automatically exported with the recipe. | ||
|
|
||
| Whatever the option activated, the data resolved will be asigned by Conan to the corresponding field, so |
There was a problem hiding this comment.
This sentence sounds strange to me. Better use Whichever *configuration* is set... or completely rephrase to something like:
Suggested change
| Whatever the option activated, the data resolved will be asigned by Conan to the corresponding field, so | |
| The data resolved from the `scm` attribute, will be assigned by Conan to the corresponding field in relation to the `scm_to_conandata` configuration. that way, |
reference/conanfile/attributes.rst
Outdated
| .. warning:: | ||
|
|
||
| By default, in Conan v1.x the information after evaluating the attribute ``scm`` will be stored in the | ||
| *conanfile.py* file (it will be modified) and any value will be written in plain text (watch out about |
There was a problem hiding this comment.
Suggested change
| *conanfile.py* file (it will be modified) and any value will be written in plain text (watch out about | |
| *conanfile.py* file (the recipe will be modified when exported to the cache) and any value will be written **in plain text** (watch out about |
| By default, in Conan v1.x the information after evaluating the attribute ``scm`` will be stored in the | ||
| *conanfile.py* file (it will be modified) and any value will be written in plain text (watch out about | ||
| passwords). However, you can activate the :ref:`scm_to_conandata<conan_conf>` config option, the *conanfile.py* | ||
| won't be modified (data is stored in a different file) and the fields ``username`` and ``password`` won't be |
There was a problem hiding this comment.
Username and password are NEVER stored or they are not stored only if I set scm_to_conandata = True?
There was a problem hiding this comment.
Previous behavior is exactly the same, no changes, conanfile.py will be modified and the user/password will be stored in plain text.
New behavior, activated with scm_to_conandata=True won't store user/passw, won't modify the recipe file (breaking, opt-in)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs for conan-io/conan#6334