Skip to content

Latest commit

 

History

History
101 lines (73 loc) · 2.57 KB

README.md

File metadata and controls

101 lines (73 loc) · 2.57 KB

SN Update Set Extractor

A ServiceNow utility designed to streamline the process of extracting code from update sets.

Overview

This utility, written in Go, processes ServiceNow update sets. It extracts and organizes code from XML files into corresponding directories and files, making it easier to use in an IDE.

Prerequisites

Getting Started

Clone the repository & change directory:

git clone https://github.com/stevengregory/sn-update-set-extractor
cd sn-update-set-extractor

Load Update Sets

In the root of the project, create a data directory.

mkdir data

Load your update sets into this directory. When running the project, the utility will process all XML files it contains.

Building & Running

To build and run the project, use the following commands:

make clean  # Remove any previous build and output files
make build  # Compile the Go project
make run    # Execute the compiled binary

Run the make command to perform all of these steps in one go:

make

Generated Output

After building & running the project, the extracted code is structured and saved in the dist directory. Each file type is categorized under a parent directory for easy navigation. For example, the output directory structure might look like:

dist/
├── Client Development/
│   ├── Client Script/
│   └── UI Script/
├── Server Development/
│   ├── Business Rule/
│   ├── Fix Script/
│   ├── Script Include/
│   └── UI Action/
├── Service Portal/
│   ├── Angular ng-template/
│   ├── Header | Footer/
│   ├── Page/
│   ├── Style Sheet/
│   ├── Theme/
│   └── Widget/
│   └── Widget Angular Provider/
└── Inbound Integrations/
    └── Scripted REST Resource/

Supported File Types

Currently, the extraction & organization of the following ServiceNow file types is supported:

  • Angular ng-template
  • Business Rule
  • Client Script
  • Fix Script
  • Header | Footer
  • Page
  • Script Include
  • Scripted REST Resource
  • Style Sheet
  • Theme
  • UI Action
  • UI Script
  • Widget
  • Widget Angular Provider

Efforts to support additional file types are ongoing. If there's a specific file type you'd like to see supported, please create an issue in the GitHub repository.

Changelog

For a detailed breakdown of all changes made to this project, see the CHANGELOG file.

License

This project is licensed under the terms of the MIT license. See the LICENSE file.