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

Proposal: explicit setting for disabling site publishing #137

Closed
danicheg opened this issue Feb 3, 2022 · 2 comments · Fixed by #183
Closed

Proposal: explicit setting for disabling site publishing #137

danicheg opened this issue Feb 3, 2022 · 2 comments · Fixed by #183
Labels

Comments

@danicheg
Copy link
Member

danicheg commented Feb 3, 2022

This was born from a discussion typelevel/log4cats#603 (review).

The site plugin contains the tlSitePublishBranch setting which could have a None value. But that would mean the site will still publishing just only for tags. There are cases when building the site is fine, but publishing is redundant. It's the case of the multibranch project without a versioned site. A versioned site for such projects could be redundant at all. So it would be nice to have the ability to disable site publishing from plugin settings.
On the other hand, one can set tlSitePublishBranch to the main branch from which the site will be publishing, but it would be more clear if one can explicitly disable the publishing site.
So this proposal is just about getting more configurable behavior through explicit settings rather than getting functionality at all.

@armanbilge
Copy link
Member

armanbilge commented Feb 3, 2022

Yeah I was thinking this yesterday too. You are right that it is confusing. We could add a tlSitePublishTags := true/false setting but then raise an error if this is true and tlSitePublishBranche := Some(...) because you can only publish from one thing.

There are cases when building the site is fine, but publishing is redundant. It's the case of the multibranch project without a versioned site.

Out of curiosity: if you are not publishing the site from an old branch, is there a point to building it?

@danicheg
Copy link
Member Author

danicheg commented Feb 3, 2022

Out of curiosity: if you are not publishing the site from an old branch, is there a point to building it?

It's a sort of thin ice, I guess. The older branches shouldn't have docs (I mean site) then. But one day, a project may decide to have a versioned site. Then backporting it from upstream would be pretty painful.

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

Successfully merging a pull request may close this issue.

2 participants