search

stryker-mutator / stryker-mutator.github.io

Repository to maintain our stryker-mutator.io website
https://stryker-mutator.github.io
Apache License 2.0
26 stars 29 forks source link

docs: use latest tag when updating docs #860

Open xandervedder opened 3 weeks ago

xandervedder commented 3 weeks ago

I think we should use this instead of always retrieving the HEAD.

Old pull request: #484 Related issue: #345

For the future it might be worth looking at multi-instancing the docs: https://docusaurus.io/docs/docs-multi-instance That way we could have versioning seperately for each stryker project.

netlify[bot] commented 3 weeks ago

Deploy Preview for stryker-mutator failed.

Name Link
Latest commit
Latest deploy log https://app.netlify.com/sites/stryker-mutator/deploys/66793daaedf85b71a5ad5e69
xandervedder commented 3 weeks ago

Correct. I tried implementing it with multiple versions, but it didn’t really work that well.

hugo-vrijswijk commented 2 weeks ago

As I mentioned in the last PR, I still don't think the feature is a good idea in this state. Stryker-js having broken docs and needing a release is a prime example of it. Yes, we should release frequently. Stryker4s hasn't had a release in two months due to slowed development. But having to create releases just to fix the docs is not a good reason IMO. I also don't really see the added benefit of only having the latest release. If it's just so that you don't see new docs, then releasing more frequently seems like a good solution 😉. Stryker4s has a "since" line in configuration that also fixes this. But the downside of missing contributions and fixes is quite a big negative for me.

I would still be in favour of having versioned docs of a few last versions and a "next" version

xandervedder commented 2 weeks ago

I would still be in favour of having versioned docs of a few last versions and a "next" version

This would be difficult to implement as all the stryker frameworks have separate versions. I think multi-instancing docusaurus (https://docusaurus.io/docs/docs-multi-instance) is the way to go here. I am not sure how to implement that though and it would require some more set up in the different repositories.