add fix-readme-badges boost example

Author: patinthehat

examples/fix-readme-badges/1.0.0/fix-readme-badge.js

@@ -0,0 +1,40 @@
+/** @type {import('@/lib/Boost').BoostScriptHandler} */
+module.exports.handler = async function ({
+    boost, repository, git, libs, tools 
+}) {
+    let filename = repository.path + '/README.md';
+
+    if (!libs.fs.existsSync(filename)) {
+        boost.log('stopping, no readme found');
+        return true;
+    }
+
+    boost.log('checking readme: ' + libs.path.basename(filename));
+
+    let fileContent = tools.readfile(filename);
+
+    if (!fileContent.includes('img.shields.io/github/workflow/status/')) {
+        boost.log('stopping, no broken workflow badge found');
+        return true;
+    }
+
+    const workflowNameMatches = fileContent.match(/img\.shields\.io\/github\/workflow\/status\/[^/]+\/[^/]+\/([^?]+)/);
+
+    if (!workflowNameMatches) {
+        boost.log('stopping, no workflow name found');
+        return true;
+    }
+
+    fileContent = fileContent.replaceAll('img.shields.io/github/workflow/status/', 'img.shields.io/github/actions/workflow/status/');
+    fileContent = fileContent.replaceAll(`/status/${workflowNameMatches[1]}`, `/status/${libs.path.basename(boost.state.testWorkflowFile)}`);
+
+    boost.log(`Updated badge url`);
+
+    tools.writefile(filename, fileContent);
+    boost.changedFiles.push(filename);
+
+    await git.add(filename);
+    await git.commit(`fix readme badge`);
+
+    return true;
+};

examples/fix-readme-badges/1.0.0/init.js

@@ -0,0 +1,41 @@
+const findTestWorkflow = async function ({
+    boost, git, libs, repository, tools 
+}) {
+    boost.log('finding tests workflow...');
+
+    if (typeof boost.state.testWorkflowFile === 'string' && boost.state.testWorkflowFile.length > 0) {
+        boost.log('found tests workflow');
+        return boost.state.testWorkflowFile;
+    }
+
+    boost.state.testWorkflowFile = '';
+
+    for (const file of libs.fs.readdirSync(repository.path + '/.github/workflows', { encoding: 'utf-8', withFileTypes: true })) {
+        if (file.isDirectory()) {
+            continue;
+        }
+
+        if (file.name.endsWith('.yml') || file.name.endsWith('.yaml')) {
+            const data = tools.readfile(repository.path + '/.github/workflows/' + file.name);
+            if (data.includes('test') && (data.includes('phpunit') || data.includes('pest'))) {
+                boost.log('found tests workflow ' + file.name);
+                boost.state.testWorkflowFile = repository.path + '/.github/workflows/' + file.name;
+                return boost.state.testWorkflowFile;
+            }
+        }
+    }
+
+    boost.log('could not find tests workflow');
+    return false;
+};
+
+/** @type {import('@/lib/Boost').BoostScriptHandler} */
+module.exports.handler = async function (params) {
+    params.boost.log('initializing boost...');
+
+    params.boost.state.testWorkflowFile = '';
+
+    await findTestWorkflow(params);
+
+    params.boost.log('finished initializing boost');
+};

examples/fix-readme-badges/1.0.0/pull-request-body.edge.md

@@ -0,0 +1,5 @@
+## Summary
+
+This PR fixes a broken badge in the README.
+
+_id:{{boost.id}}/v{{boost.version}}_

examples/fix-readme-badges/boost.js

@@ -0,0 +1,18 @@
+/** @type {import('@/types/BoostConfiguration').BoostConfiguration} */
+module.exports.default = {
+    id: 'fix-readme-badges',
+    version: '1.0.0',
+    repository_limits: {
+        max_runs_per_version: 1,
+        minutes_between_runs: 60,
+    },
+    pull_request: {
+        title: 'Fix Readme badges',
+        body: 'pull-request-body.edge.md',
+        branch: 'fix-readme-badges',
+    },
+    scripts: {
+        parallel: true,
+        files: [ 'fix-readme-badge.js' ],
+    },
+};