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

Add destination-path argument allowing overriding destination #97

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

romainbou
Copy link
Contributor

Add "destination-path" option to allow picking the destination of all the generated readme files.

This allows saving all the documentation in a subfolder like docs inside a repository.
Example goreadme -import-path=. -destination-path=docs/README.md
Will generate docs/README.md instead of README.md

@codecov
Copy link

codecov bot commented Nov 26, 2020

Codecov Report

Merging #97 (5381a31) into master (7e9b8ca) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #97   +/-   ##
=======================================
  Coverage   69.51%   69.51%           
=======================================
  Files           3        3           
  Lines          82       82           
=======================================
  Hits           57       57           
  Misses         15       15           
  Partials       10       10           
Impacted Files Coverage Δ
goreadme.go 67.34% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7e9b8ca...5381a31. Read the comment docs.

@posener
Copy link
Owner

posener commented Nov 28, 2020

Hey, you can actually set the output path: env 'readme-file=docs/readme.md' goreadme, or with the readme-file argument for the Github action.

In the PR, you also created the parent directory, which we can add in any case.

Does that work for you?

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.

2 participants