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

docs: use latest tag when updating docs #860

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

Conversation

xandervedder
Copy link
Contributor

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.

Copy link

netlify bot commented Jun 21, 2024

Deploy Preview for stryker-mutator failed.

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/stryker-mutator/deploys/66793daaedf85b71a5ad5e69

Copy link
Member

@rouke-broersma rouke-broersma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The build seems to be failing because stryker-js has not yet released a new version containing a fix for the links in their docs. Stryker-js needs to release a new version before we can merge this.

Am I correct that the versions.json containing both the stable and preview/unreleased/vnext is not included in this change?

@xandervedder
Copy link
Contributor Author

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

@hugo-vrijswijk
Copy link
Member

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
Copy link
Contributor Author

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.

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