Skip to content
This repository has been archived by the owner on Oct 30, 2018. It is now read-only.

module: system/make #985

Merged
merged 3 commits into from
Mar 25, 2016
Merged

module: system/make #985

merged 3 commits into from
Mar 25, 2016

Conversation

LinusU
Copy link
Contributor

@LinusU LinusU commented Sep 16, 2015

This is a new module that runs the make command on the target. The benefit of using this module instead of the shell module is that it supports "check mode" and only reports changed where appropriate.

@LinusU
Copy link
Contributor Author

LinusU commented Sep 16, 2015

Code is now also 100% PEP8 compliant 👍

@robynbergeron
Copy link
Contributor

Hi Linus,

Thanks for submitting this new module. ;)

Per the Ansible module guidelines: http://docs.ansible.com/developing_modules.html#module-checklist -- can you update the author line and add in your github ID? Thanks!

@LinusU
Copy link
Contributor Author

LinusU commented Sep 19, 2015

Sorry, I actually read thru that but I must have missed that line. Amending now.

@LinusU LinusU force-pushed the make-module branch 2 times, most recently from 439ca1f to 909c004 Compare September 19, 2015 10:22
@LinusU
Copy link
Contributor Author

LinusU commented Sep 19, 2015

Looking around for how I should specify it I noticed that there are some inconsistencies in how each module specify it's info. I changed the author line to be Full name (@GithubName) <EmailAddress>. I also changed the version_added to be a string; there are still a number of modules that have this as a float thought.

@LinusU
Copy link
Contributor Author

LinusU commented Sep 21, 2015

@robynbergeron Care to review my changes? 😄 👍

@robynbergeron
Copy link
Contributor

@LinusU yeah, there are definitely inconsistencies around :) Doing our best to catch up with the old ones, and make sure new things are coming in with the right info. The most useful thing for myself and @gregdek as triage folks is to be able to actually find a github ID quickly rather than consulting the googleverse :) (I can't comment on the string vs. float -- not sure if that's something @gregdek has been looking at or not in our triage-a-thon?)

Thanks for the update -- I'll put this in community_review, with the new community PR review process info :)

@robynbergeron
Copy link
Contributor

Thanks for submitting this new module to Ansible Extras! This module is now in community review, a process that is open to all Ansible users. In order for this module to be approved, it must gain the following votes:

“works_for_me”: If you have tested the module thoroughly, including testing of all of the module’s options, and if the module works for you, please add “works_for_me” in the comments.

“passes_guidelines”: If you have gone through the module guidelines and the module meets all of the requirements, please add “passes_guidelines” in the comments. Guidelines are available here: http://docs.ansible.com/developing_modules.html#module-checklist

“needs_revision”: If the module fails to work for you, or if it doesn’t meet guidelines, please add “needs_revision” in the comments with details about what needs to be fixed.

When a module has both “works_for_me” and “passes_guidelines” tags, we will promote the module for inclusion in Ansible Extras. At this point, you will be expected to maintain the module by fixing bugs and evaluating pull requests in a timely manner.

Thanks again for submitting your Ansible module!

@conorsch
Copy link

conorsch commented Oct 2, 2015

Great addition! Goes nicely with the patch module. Regarding the new revision rules:

  • works_for_me
  • passes_guidelines

Cheers!

@LinusU
Copy link
Contributor Author

LinusU commented Oct 3, 2015

Thank you! \o/

@robynbergeron
Copy link
Contributor

@conorsch -- thanks for reviewing this for both guidelines and functionality!

@LinusU -- Congratulations! You are now the maintainer of a module in Extras. Thanks so much for your contribution!

Marking this shiny new module for inclusion... one of the first to be moving in under the new policy for reviewing new extras modules. YAY, validation!

(Sorry, I'm excited :D)

cc @ansible/core team.

@conorsch
Copy link

@robynbergeron The new guidelines are a huge improvement—thanks for advocating for more inclusive reviews!

@LinusU
Copy link
Contributor Author

LinusU commented Oct 10, 2015

Awesome!!

@bcoca bcoca added this to the next milestone Oct 12, 2015
@robynbergeron
Copy link
Contributor

@conorsch -- I'm delighted to hear that :) Tell your friends! :D I'm super hopeful that people will remember to pass on the review love their modules receive -- or that those giving reviews will have receive them back in the future :)

@bcoca bcoca modified the milestone: next Oct 19, 2015
@bcoca bcoca added this to the next milestone Oct 19, 2015
supports_check_mode=True,
argument_spec=dict(
target=dict(required=False, default=None),
params=dict(required=False, default=None),
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense for params to be a dict type or is it really any free form string?

@abadger
Copy link
Contributor

abadger commented Jan 11, 2016

@LinusU hey, I was just going through tickets I'd commented on and saw that this one still had my question about the type of the params argument. Any information from you?

@bcoca bcoca removed the shipit label Jan 11, 2016
@LinusU
Copy link
Contributor Author

LinusU commented Jan 12, 2016

Sorry, this has fallen thru the cracks.

I think it makes sense to let params be a dict type, I'll update the code.

module: make
short_description: Run targets in a Makefile
requirements: []
version_added: "1.9"
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this also need to be updated

@sivel
Copy link
Member

sivel commented Mar 19, 2016

============================================================================
make.py
============================================================================
ERROR: version_added should be 2.1. Currently 1.9
ERROR: No RETURN documentation provided
ERROR: ansible.module_utils.basic import not near call to main()

@gregdek
Copy link
Contributor

gregdek commented Mar 21, 2016

@LinusU A friendly reminder: this pull request has been marked as needing your action. If you still believe that this PR applies, and you intend to address the issues with this PR, just let us know in the PR itself and we will keep it open pending your changes.

@LinusU
Copy link
Contributor Author

LinusU commented Mar 22, 2016

Yes, sorry for the delay on this, I'll update as soon as I can :)

@LinusU
Copy link
Contributor Author

LinusU commented Mar 24, 2016

'ready_for_review'

Updated to use dict 🙌

@sivel
Copy link
Member

sivel commented Mar 24, 2016

There are still 2 failing checks:

============================================================================
make.py
============================================================================
ERROR: No RETURN documentation provided
ERROR: ansible.module_utils.basic import not near call to main()

@LinusU
Copy link
Contributor Author

LinusU commented Mar 25, 2016

Does anyone know how the RETURN doc should look when not returning any values?

Also, is there any reasoning on "ansible.module_utils.basic import not near call to main()" somewhere? It breaks PEP8.

@LinusU
Copy link
Contributor Author

LinusU commented Mar 25, 2016

Should work now 👍

@bcoca bcoca merged commit 6978984 into ansible:devel Mar 25, 2016
@LinusU LinusU deleted the make-module branch March 25, 2016 17:49
@LinusU
Copy link
Contributor Author

LinusU commented Mar 25, 2016

Thanks 🙌

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants