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

README.md generataion should not happen automatically #23

Closed
ufobat opened this Issue Aug 19, 2017 · 8 comments

Comments

2 participants
@ufobat

ufobat commented Aug 19, 2017

I want to use mi6 to build the tarballs to upload them to pause.cpan.org. Unfortunately it is quite complicated regarding the README.md handling.

I need to reverte the changes to the README.md after the mi6 dist command. Then I need to copy the changes into the folder and rebuild the tarball manually.

  1. README.md generation should only happen if it is requested with a command

in addition:
2) README.md generation makes assumptions which can not be overriden with some command line switches. e.g whether I want to have a travis.ci header or not, which file should be converted to README.md, maybe it makes even sense to convert more then one pm6 file to markdown.

@skaji

This comment has been minimized.

Show comment
Hide comment
@skaji

skaji Aug 19, 2017

Owner

It could be nice that mi6 allows you have a configuration file, in which you explicitly disables regenerating README.

Owner

skaji commented Aug 19, 2017

It could be nice that mi6 allows you have a configuration file, in which you explicitly disables regenerating README.

@ufobat

This comment has been minimized.

Show comment
Hide comment
@ufobat

ufobat Aug 19, 2017

what about either
mi6 dist --keep-readme
mi6 build --keep-readme
or
merging #3 and then
mi6 build-readme && mi6 build?

I would write a PR if you like :)

ufobat commented Aug 19, 2017

what about either
mi6 dist --keep-readme
mi6 build --keep-readme
or
merging #3 and then
mi6 build-readme && mi6 build?

I would write a PR if you like :)

@skaji

This comment has been minimized.

Show comment
Hide comment
@skaji

skaji Aug 19, 2017

Owner

Do you really like --keep-readme option?
It is easy to imagine that you sometimes forget to add that option to mi6 build.

Owner

skaji commented Aug 19, 2017

Do you really like --keep-readme option?
It is easy to imagine that you sometimes forget to add that option to mi6 build.

@ufobat

This comment has been minimized.

Show comment
Hide comment
@ufobat

ufobat Aug 19, 2017

I am happy for any working sulution 👍
Personally i'd prefere merging #3 and mi6 build-readme && mi6 build over --keep-readme over having a config file.

ufobat commented Aug 19, 2017

I am happy for any working sulution 👍
Personally i'd prefere merging #3 and mi6 build-readme && mi6 build over --keep-readme over having a config file.

@skaji

This comment has been minimized.

Show comment
Hide comment
@skaji

skaji Aug 19, 2017

Owner

Personally i'd prefere merging #3 and mi6 build-readme && mi6 build over --keep-readme over having a config file.

#3 is just to add a build-readme command. So even after merging #3, mi6 build regenerates README anyway.

Owner

skaji commented Aug 19, 2017

Personally i'd prefere merging #3 and mi6 build-readme && mi6 build over --keep-readme over having a config file.

#3 is just to add a build-readme command. So even after merging #3, mi6 build regenerates README anyway.

@skaji

This comment has been minimized.

Show comment
Hide comment
@skaji

skaji Aug 19, 2017

Owner

Note that I will not change the behavior (regenerating README) of mi6 build.
On the other hand, it may be possible to change the behavior by some command line options or some configuration files.

Owner

skaji commented Aug 19, 2017

Note that I will not change the behavior (regenerating README) of mi6 build.
On the other hand, it may be possible to change the behavior by some command line options or some configuration files.

@skaji

This comment has been minimized.

Show comment
Hide comment
@skaji

skaji Aug 19, 2017

Owner

I respect Perl5/6's pod feature.

Owner

skaji commented Aug 19, 2017

I respect Perl5/6's pod feature.

@ufobat

This comment has been minimized.

Show comment
Hide comment
@ufobat

ufobat Aug 19, 2017

would you accept a --keep-readme option for your commands? in that case i'll write a PR asap

ufobat commented Aug 19, 2017

would you accept a --keep-readme option for your commands? in that case i'll write a PR asap

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment