Configuration-as-code-plugin: README claims JCasC is included when running as Docker, but it isn't

[ChristianCiach]

Description

The README states this:

Those running Jenkins as a Docker container (and maybe also pre-installing plugins), do include Configuration as Code plugin.

I am not entirely sure what the part "and maybe also pre-installing plugins" means in this context, but when running jenkins/jenkins:lts, the JCasC plugin is not available without installing it manually.

[jetersen]

@ChristianCiach you have to pre-install plugins: https://github.com/jenkinsci/docker#preinstalling-plugins

[ChristianCiach]

Well, duh, of course the plugin is "included" when explicitly preinstalling it :) This is true even when not running Jenkins as a Docker container.

[jetersen]

That's one the readme is referring to, that you need to preinstall plugins.

if you want jenkins/jenkins:lts to include JCasC that is a PR for https://github.com/jenkinsci/docker

[jetersen]

Feel free to send a PR that updates the readme if you find that section confusing, no need to create an issue about it.

[ChristianCiach]

Well, if you think that it's okay when something claims "batteries included" but you still need to buy and insert them manually, then I seriously cannot help you.

[jetersen]

I do not maintain the jenkins docker image so 🤷‍♂
Again feel free to update the wording in the readme, I'll happily accept a PR.
The readme is best maintained by those who reads it.

Reading the section in context

First, start a Jenkins instance with the Configuration as Code plugin installed.

• Those running Jenkins as a Docker container (and maybe also pre-installing plugins), do include Configuration as Code plugin.

You could properly reword

needs to include Configuration as Code plugin.

Clearly something was lost when the readme was last edited in the section.

[ChristianCiach]

I do not claim that there is something wrong with the docker image. I claim that the Readme of this project is misleading and, if you omit the part inside the parenthesis (which, in my understanding, parenthesis are for), totally wrong. I was hoping that this could be corrected by someone with write access, without requiring me to jump through hoops (forking, branching, cloning, editing, pushing, creating PR). I was clearly wrong about that, so let's just run other people into this pitfall.

[jetersen]

you can edit the readme from github web page without the hassle, I do not see your issue 🤔

[jetersen]

https://help.github.com/en/github/managing-files-in-a-repository/editing-files-in-your-repository

[ChristianCiach]

you can edit the readme from github web page without the hassle, I do not see your issue

I didn't know about that :D Thanks for that. I will do that next time.