Action to merge changes made by script back into repo

[franreyn]

Select Topic Area

Question

Body

I currently have an action setup that will (1) checkout my repo (2) install node and dependencies (3) run a script that takes my directories/files and creates a JSON file with all their file paths. I am needing this action to take this JSON file and merge it back into my repo so that I may use the GitHub API to retrieve it. My code is as follows.

Everything runs okay but the new toc.json doesn't appear in my repo. I am guessing that I need an action that merges the changes into my main branch.

workflow:

name: build-toc-json
run-name: ${{ github.actor }} is building the table of contents JSON
on: push
jobs:
  build-toc-json:
    runs-on: macos-11
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '18'
      - run: npm install node-dir
      - run: node buildNav

script that runs when I use node buildNav

const fs = require("fs");
const dir = require('node-dir');

// display contents of files in this directory
dir.readFiles("src/chapters",
  // get content of files
  function(err, content, next) {
      if (err) throw err;
      next();
  },
  // get file names
  function(err, files){
      if (err) throw err;

      // if `dist` folder does not exist create it
      try {
        fs.readdirSync("api");
      } catch (e) {
        fs.mkdirSync("api");
      }

      // map through file names and remove `dist/`
      let paths = files.map((path) => {
        let replaced = path.replace("dist", "");
        return replaced;
      });

      // create JSON file of our navigation
      fs.writeFile("api/toc.json", JSON.stringify(paths), err => {
        if (err) return console.log(err);
      });
      
});

[spenserblack]

This action is probably the easiest way to achieve that: https://github.com/stefanzweifel/git-auto-commit-action

[franreyn]

Ah, thank you. At a quick glance it does look like what I need. I will try it out and return here to post my results.

[franreyn]

This worked! Thank you. I will post my updated yml file. Note: With these options I had to disable branch protections to allow merges with no review or pull request.

name: build-toc-json
run-name: ${{ github.actor }} is building the table of contents JSON
on: push
jobs:
  build-toc-json:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '18'
      - run: npm install node-dir
      - run: node buildNav
      - uses: stefanzweifel/git-auto-commit-action@v4
        with:
          commit_message: Merged toc.json