feat: Initial version

[oscard0m]

Your new script is ready to be implemented 🎉

You can run it locally on your machine with

node cli.js

Once you are happy with it, push your changes to this pull request

git commit -a -m "feat: initial version"
git push

Before merging:

• Install the Octoherd GitHub App
• Add NPM_TOKEN to the repository secrets. Set it to an npm automation token

---

Issues to solve

Before first release

• To not open a PR if there are no setup-node changes (https://github.com/oscard0m/web/pull/50/files?diff=unified&w=1)
• If there is no .github/workflow dir, skip (i.e. {"name":"HttpError","status":404,"response":{"url":"https://api.github.com/repos/oscard0m/webpack-tutorial/contents/.github%2Fworkflows","status":404,"headers":{"access-control-allow-origin":"*","access-control-expose-headers":"ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, … })

After first release

• tests ⚠️ ⚠️ ⚠️ ⚠️ ⚠️
• To add a flag to opt-in/opt-out run prettier before dumping the file
• If setup-node@version is lower than 2, bump the version too: https://github.com/oscard0m/wefox-tech-challenge/pull/1/files
  • Consider non-version use case: actions/setup-node@hshkjdfsa9
• Respect ' 🆚 " if prettier is not applied (i.e. https://github.com/oscard0m/docs/pull/222/files#diff-3ad1230e5b1d55de790c0e21263e31b88917a2d1229af87484ca13075ad646c4R9)
• To not add null option when dumping back the file (i.e.: https://github.com/oscard0m/nginx-hackathon-2020/pull/86/files)

[oscard0m]

Context

setup-node GitHub Action just released a new option to add cache to setps using it.
Deteails here: https://github.blog/changelog/2021-07-02-github-actions-setup-node-now-supports-dependency-caching/

Mission

• I would like to automate to add this cache option to all my GitHub Actions with setup-node
• Do you think this could be interesting for Octokit and other orgs? @gr2m
• I have implemented an initial version of an Octoherd script to add cache property to all the GitHub Actions using actions/setup-node. I did not test it exhaustively yet but I have an initial PR opened [EDIT 4/7/2021]: here here

Problems

I'm using js-yaml which it applies some extra changes which add a bit of noise of the PR. When parsing and dumping back the yaml file:

• It does not preserve comments of the file
• It does not preserve newlines as before
• Transforms arrays to indented newlines

[EDIT 4/7/2021]: I come up with a solution with yaml library instead of js-yaml. Kudos to @eemeli. You can find details here

Review Request

@gr2m I would like you to take a look when you have time and, specially if you would see this valuable or not that important.

Thanks in advance

---

Most of the lines are inspired by @wolfy1339 in this repo: https://github.com/wolfy1339/octoherd-script-fix-prettier-update
I see some room to wrap some logic into @octokit plugins here.

[wolfy1339]

Can you pass it through prettier before writing the file? That could solve the issue with indentation

[oscard0m]

Can you pass it through prettier before writing the file? That could solve the issue with indentation

Running npx prettier --parser yaml <file> --write does not convert sequences to arrays since they are both YAML valid and equivalent.

Tried using yaml library (the one used by prettier) and no luck neither. It seems I'm not the only one with this issue.

I'm not sure if there is a cool way to parse/dump yaml files and not lose data/format in the process. Posted an issue to js-yaml.

---

[EDIT 4/7/2021]: I made it work after asking for help in eemeli/yaml#220 (reply in thread)
🍾 🍾 🍾 (this solution implied running prettier too, thanks for that tip @wolfy1339)

[gr2m]

• Do you think this could be interesting for Octokit and other orgs? @gr2m

Absolutely! I just talked about this exact thing with @travi

[gr2m]

Thanks for creating this script! I think folks will love it!

[github-actions]

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀