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 two distros shipping bats-core to the docs #659

Merged

Conversation

henning-schild
Copy link
Contributor

@henning-schild henning-schild commented Sep 26, 2022

@henning-schild henning-schild requested a review from a team as a code owner September 26, 2022 19:22
@henning-schild
Copy link
Contributor Author

We could think about adding the name of the package the distros did choose, maybe even install instructions. But the already listed distros do not do that so i did not try.

@henning-schild
Copy link
Contributor Author

I bet that adds some value for users, seeing that they can install the package with their distro. It also should add value to this very project, seeing and tracking who ships and appreciates the code.

@henning-schild
Copy link
Contributor Author

in fact we also have opensuse Linux and fedora Linux, possibly more

i will try and complete the list if that gets merged or there are more questions, right now i care about Debian and Gentoo

@martin-schulze-vireso
Copy link
Member

I think we have to be careful with the wording here. While I assume Bats to be compatible with all major Linux distributions that provide Bash, we only have a small subset of CI tested versions, which are truly "supported".

All other distributions might be listed as providing a package but should not come with the expectation of being tested, at least not from our side.

@henning-schild
Copy link
Contributor Author

I see. In that case you decide what to do with that. Feel free to just close or throw commits on top that list distros in general and list the ones tested by bats itself.

The file is named "installation" but right it talks about tested and supported.

martin-schulze-vireso added a commit to henning-schild/bats-core that referenced this pull request Oct 5, 2022
@martin-schulze-vireso
Copy link
Member

martin-schulze-vireso commented Oct 5, 2022

I restructured the text and added some of your suggestions. Please review the new layout to see whether it is still understandable.

@henning-schild
Copy link
Contributor Author

Looking good. You as the maintainer might find that support matrix and which one is tested how important, for a user install instructions are more relevant and the test matrix and coverage and exact versions might be something to look at when running into issues. Or maybe when having to manually install.

So all that should rather move down in the document, as additional but not primary information. Maybe all the way to the end. Hope that makes sense.

@henning-schild
Copy link
Contributor Author

The typical scenario is ... you want to install, you read that, see your distro ... stop reading and install via that distro. Trusting it will do things right for you.

martin-schulze-vireso added a commit to henning-schild/bats-core that referenced this pull request Oct 19, 2022
@martin-schulze-vireso
Copy link
Member

martin-schulze-vireso commented Oct 19, 2022

Please review the new layout to see whether it is still understandable.

So all that should rather move down in the document, as additional but not primary information. Maybe all the way to the end. Hope that makes sense.

I restructured a bit further and moved the support matrix into its own document. The link above points to the updated documentation.

@henning-schild
Copy link
Contributor Author

LGTM, thanks!

@martin-schulze-vireso
Copy link
Member

Thanks for you contribution. Sorry about the confusion, I accidentally closed instead of merging.

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.

None yet

2 participants