Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs about 'scm_to_conandata' #1522

Merged
merged 2 commits into from Jan 15, 2020
Merged

Conversation

jgsogo
Copy link
Member

@jgsogo jgsogo commented Jan 14, 2020

Copy link
Member

@memsharded memsharded left a comment

Please check the comment, fix it, and can be merged.

@@ -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
Copy link
Member

@memsharded memsharded Jan 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

%s? Not sure what is this change

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.
Copy link
Member

@danimtb danimtb Jan 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to the conandata.yml reference

* 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
Copy link
Member

@danimtb danimtb Jan 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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,

.. 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
Copy link
Member

@danimtb danimtb Jan 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

@danimtb danimtb Jan 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Username and password are NEVER stored or they are not stored only if I set scm_to_conandata = True?

Copy link
Member Author

@jgsogo jgsogo Jan 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Member

@danimtb danimtb Jan 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, it is fine then 👍

@jgsogo jgsogo merged commit feb4c03 into conan-io:develop Jan 15, 2020
2 checks passed
@jgsogo jgsogo deleted the pr/6334-scm_to_conandata branch Jan 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants