API functionality to retrieve GHAS Custom Pattern dry run results

[cmellazchy]

Select Topic Area

Product Feedback

Body

Hi GitHub team,

Can we have API functionality to get Custom Pattern dry run results in the same way that we have for secret scanning alerts?
From the documentation, it seems like the dry run will give a sample of 1000 results. (I'm running the dry run on the entire organization)
It's hard to read the data from the UI since there are only 5 results shown per page.
The dry run results are very helpful in enhancing the pattern to reduce false positives.

Thanks.

[antpili]

here's some javascript that will scrape the results for you - all links will be stored in the variable o

function getNextButton() {
	var buttons = document.getElementsByTagName("button");
	for (button of buttons) {
		if (button.name == "next_cursor_button") {
			return button;
		}
	}
}

function getForm() {
	let f = document.getElementsByClassName("ajax-pagination-form js-ajax-pagination");
	f = f[0];
	return f;
}

function scrapeAnchors() {
	f = getForm();
	anchors = f.getElementsByTagName('a');
	for (const i of anchors) {
		href = i.href
		// edit as needed
		if (href.indexOf('github.com/organizations') > 0) {
			continue;
		}
		o.push(href);
	}
}


var o = [];

const config = { characterData: true, subtree: true, childList: true};
const callback = (mutationList, observer) => {
	for (const mutation of mutationList) {
		console.log(mutation);
		if (mutation.addedNodes.length > 1) {
			scrapeAnchors();
			let button = getNextButton();
			console.log(button);
			button.click();
		}
	}
	
};

// initial pass 
scrapeAnchors();
getNextButton().click();

const observer = new MutationObserver(callback);
observer.observe(document.body, config);

// once its done, copy/paste this:
// let s = '';
// for (const i of o) {
// 	s += i + "\n"
// }
// console.log(s);