Evilweed/chatops-pr

Betterer TypeScript Chatops

This repository is a Demo that shows how to use Betterer Github Action in a way that improves Developer Experience. This means that you no longer need to run Betterer before commit.

Check how it looks in PullRequest

#64

Example of PR messages

Example of CI job results

How does this workflow look like:

1. Commit new typescript changes
2. CI/CD github action uses Betterer Github Action to run Betterer that compiles TypeScript with stricter settings
3. If there are changes detected during compilation by Betterer (that means - fixed or new TS offences), custom reporter:
   • prints summary of those changes
   • prints information about the whole initiative of improving TS practices
   • prints information about ways to proceed right now, that is:
     • ✅ Fix the issues: Developer can fix new issues he has added right now;
     • ⚠️ Update results file: Or, Developer can accept new offences as something we can live with right now, by adding comment with betterer:update text into Pull Request. This comment will trigger following events:
       • new CI job is triggered
       • that CI job runs Betterer with --update flag
       • which generates new betterer.results file that contains current state of TS offences
       • commits this file to current branch
       • sends PR comment that gives nice summary of changes (amout of fixed/added issues)

How to set it up in your project

1. Create new branch in repository of your project
2. Run yarn add @betterer/cli@5.1.5 --dev in your project directory
3. Run yarn add @betterer/typescript@5.1.5 --dev in your project directory
4. Copy .betterer.results file to repository/directory of your project
5. Copy .betterer.ts file to repository of your project
6. Search for <--- Adapt to your project needs text in it and update those places to your project needs
7. Copy .github/workflows/betterer--your-project-name.yml file to repository/directory of your project
8. Rename file name to use your project name in it
9. Search for <--- Adapt to your project needs text in it and update those places to your project needs
10. Copy .github/workflows/betterer-chatops--your-project-name.yml file to repository/directory of your project
11. Rename file name to use your project name in it
12. Search for <--- Adapt to your project needs text in it and update those places to your project needs
13. Copy .betterer.results file to repository/directory of your project
14. Merge those changes to master/main branch (only then all Github Actions will work)
15. Create new branch in repository of your project
16. Edit any TS or TSX file
17. Commit this change
18. Create PR out of this branch
19. Wait for Betterer CI job to fail
20. Add comment into this PR with text yourprojectname:betterer:update (in this demo the command is platform:betterer:update)
21. Wait for BOT message in PR that shows that .betterer.results file was updated
22. Thats it :)