added the Missing information on how to generate/create yaml file #2471
Conversation
docs/PLUGINS.md
Outdated
|
|
||
| ##### **Location of configuration-as-code.yml:** | ||
|
|
||
| By default, the YAML file for the CasC configuration is located in $JENKINS_HOME/jenkins.yaml. The location and name of the file being used is displayed on the Configuration as Code UI page. You can specify a different file to view by typing the full pathname into the Path or URL field. |
There was a problem hiding this comment.
these docs are not written from the right point of view. they've been written as user documentation (and basically duplicate of https://github.com/jenkinsci/configuration-as-code-plugin#getting-started)
the issue is asking for it to be part of writing an integration test where should you put the test file, e.g. this:
https://github.com/jenkinsci/azure-cosmosdb-plugin/blob/a22e3c625349d6ee2657d2f88fdef49baa3c4715/src/test/java/io/jenkins/plugins/azurecosmosdb/ConfigurationAsCodeTest.java#L29
There was a problem hiding this comment.
Okay sorry I got your point
like we have here https://github.com/jenkinsci/kubernetes-plugin/blob/master/src/test/resources/org/csanchez/jenkins/plugins/kubernetes/casc/configuration-as-code.yaml
this is the ideal place for the configuration-as-code.yaml file I have made the required changes but I am still not able to write this in a very detailed manner because the folder template is a little different for the plugins but I was able to give a general idea
over this shall I add some examples and refer to these configuration-as-code.yaml for the user?
docs/PLUGINS.md
Outdated
|
|
||
| ##### **Location of configuration-as-code.yml:** | ||
|
|
||
| The `configuration-as-code.yml` file should be located within the test resources directory (`src/test/resources`) of your project repository. Specifically, it should be placed in the same directory where your test classes reside. |
There was a problem hiding this comment.
I think this should go in the next section (configuration test) as it hasn't been mentioned about a configuration file yet, you could probably add an example file with the file path? content looks good though, almost there thanks.
There was a problem hiding this comment.
@timja I have added more information please do let me know if anything is wrong or If I need to add something more
timja
added
the
documentation
This pr is for the issue #2446
using information from https://www.jenkins.io/doc/book/managing/casc/#configuration-as-code
I was able to write the details.
Your checklist for this pull request
🚨 Please review the guidelines for contributing to this repository.