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

Saving profile list as a json file #5954

Merged
merged 2 commits into from Oct 22, 2019

Conversation

@mrunderline
Copy link
Contributor

mrunderline commented Oct 22, 2019

Changelog: Feature: Saving profile list as a json file
Docs: conan-io/docs#1449

  • Refer to the issue that supports this Pull Request.
  • If the issue has missing info, explain the purpose/use case/pain/need that covers this Pull Request.
  • I've read the Contributing guide.
  • I've followed the PEP8 style guides for Python code.
  • I've opened another PR in the Conan docs repo to the develop branch, documenting this one.

issue #5937

@CLAassistant

This comment has been minimized.

Copy link

CLAassistant commented Oct 22, 2019

CLA assistant check
All committers have signed the CLA.

@memsharded memsharded self-assigned this Oct 22, 2019
@memsharded

This comment has been minimized.

Copy link
Member

memsharded commented Oct 22, 2019

Hi @mrunderline

It is looking good, but it would need a couple of details to be complete:

  • The functionality would need a test to check that it is ok, but more importantly, that it doesn't break in the future because other changes. Please take a look to the conans/test/functional/command/profile_test.py, use one of those as a base, and add the --json argument, load the resulting file (with client.load() helper), and check the result is the expected one.
  • The docs cannot be "omit" for this PR, because it is changing the behavior. Please submit a PR to https://github.com/conan-io/docs (reference/commands section). Can be very simple, just the command line help should match what you will get if you do conan profile list --help.

Do not hesitate to ask if you have any question or need help.

Many thanks for this contribution!

@mrunderline

This comment has been minimized.

Copy link
Contributor Author

mrunderline commented Oct 22, 2019

Hi @memsharded
Thanks for your attention and kind comment.
I've added a unit test, and would you help more for documenting?
Is /reference/commands/misc/profile.rst a correct file for editing? should I add an optional arguments?

@memsharded memsharded added this to the 1.20 milestone Oct 22, 2019
@memsharded memsharded merged commit 122f7c3 into conan-io:develop Oct 22, 2019
2 checks passed
2 checks passed
continuous-integration/jenkins/pr-head This commit looks good
Details
license/cla Contributor License Agreement is signed.
Details
@memsharded

This comment has been minimized.

Copy link
Member

memsharded commented Oct 22, 2019

Good, merged! Welcome to the Conan contributors :)

Yes, the /reference/commands/misc/profile.rst is where it should go. Just adding the optional argument in the command line reference is good, no need for examples or further explanation, just to be sure that what is in the docs is consistent with the conan profile list --help output.

@mrunderline

This comment has been minimized.

Copy link
Contributor Author

mrunderline commented Oct 22, 2019

thank's a lot! I also sent a PR for documents on conan-io/docs#1449

@memsharded

This comment has been minimized.

Copy link
Member

memsharded commented Oct 23, 2019

Thanks for the docs @mrunderline

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.