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

Auto-generate README File #354

Merged
merged 2 commits into from
Dec 29, 2022
Merged

Auto-generate README File #354

merged 2 commits into from
Dec 29, 2022

Conversation

khajavi
Copy link
Member

@khajavi khajavi commented Dec 25, 2022

No description provided.

@pshirshov pshirshov merged commit 512bf26 into zio:develop Dec 29, 2022
@pshirshov
Copy link
Member

@khajavi Sorry, I'm gonna remove your workflow for now. It still tries to mess with readme.md in the root of the repo (see https://github.com/zio/izumi-reflect/pull/355/files) and there is this issue: zio/zio-sbt#86

@pshirshov
Copy link
Member

Another minor problem is that you've added docs-plugins.sbt instead of adding required plugins through sbtgen, so steward won't work.

@khajavi
Copy link
Member Author

khajavi commented Jan 7, 2023

@pshirshov No sorry, thank you for noticing me.

It still tries to mess with readme.md in the root of the repo (see https://github.com/zio/izumi-reflect/pull/355/files)

Could you explain what you mean by messing? Those changes are expected from my point of view!

and there is this issue: zio/zio-sbt#86

Can you explain the problem, I hope I can fix that.

@pshirshov
Copy link
Member

expected

I won't like the idea of changing the primary readme. If you need any docs for zio website - please keep them separate from our generic readme in the root of the repo.

explain

zio/zio-sbt#86

This is a problem with test reporter though I would prefer not to have two workflows until it is resolved.

@khajavi
Copy link
Member Author

khajavi commented Jan 7, 2023

I won't like the idea of changing the primary readme.

Yes, I know, but what is the problem with that? This is the process we have taken for all projects under the zio ecosystem.

If you need any docs for zio website - please keep them separate from our generic readme in the root of the repo.

That PR doesn't need any docs for the zio website. It removes any handwritten readme and auto-generates that from docs/index.md and also some other metadata.

So instead may I ask you to review and comment on this PR and tell me unexpected changes?

zio/zio-sbt#86
This is a problem with test reporter though I would prefer not to have two workflows until it is resolved.

I don't know how that relates to the recent change related to the zio-sbt-website plugin. As I'm not familiar with that test reporter, I appreciate it if you can explain more and explain why that relates to the docs-related works.

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.

3 participants