Is it okay to keep metadata and documentation in a ServiceNow Custom application's Github Repo?
Options
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
08-22-2024 12:16 AM
In the custom application's github repository, is it okay if we put several documentations, and metadata files, such as,
- README file
- docs/ (folder that will contain documentation around development, and application details)
- .github (folder that has github specific metadata such as CONTRIBUTORS, workflows etc.)
- .gitignore (file that can ignore certain files)
I have currently tested by putting these, and it seems to survive pushing changes from the Studio.
My testing repository: https://github.com/gbhat618/sn-dev-lab/tree/develop
So I am guessing Studio won't import anything other than
- sn_source_control.properties
- app directory (in the above this is the app folder `2999a41f1b049e106ea4ea08bc4bcbf2` where Studio generates xml files)
Also I am guessing when we publish the app to the ServiceNow store, it won't package the metadata files and folders.
Only packages the app directory, is my understanding correct? and is it makes sense to add these metadata into the repo itself for documentation and developer guidelines?
0 REPLIES 0