![Custom PR badges
Drawbacks
• M
a
int
a
in code
• Not re
a
ctive to PullRequest description ch
a
nge (unlike PRB
a
dge) except with GithubActions
(on: [edited])](https://image.slidesharecdn.com/addprbadges-241120082518-907b7c41/85/Add-badges-to-your-pull-request-and-increase-your-productivity-20-320.jpg)
Add badges to your pull request and increase your productivity
- 1. Christopher Saez - Cocoahead November Productivity enhancer 🚀 Pull Request Badges
- 2. - Gloss a ry - PullRequestB a dge.com - Custom PR B a dges - Going further - Q/A Agenda
- 3. Glossary • B a dge: Im a ge which cont a ins inform a tion, written in M a rkdown • M a rkdown: l a ngu a ge used to enh a nce text rendering in Github, Gitl a b pull request description. We c a n use HTML in m a rkdown. Some fe a tures a re restricted due to security re a sons (such a s t a rget=“_bl a nk” for ex)
- 5. Pull Request Badge https://pullrequestbadge.com • Online Tool which provide a n a wesome UI to build b a dge for your PR to be a dded on Github • Github App (exclusiv for Github) • P a id • E a sy to integr a te a nd use (few clicks only) • Works with a con f igur a tion f ile loc a ted in .github folder n a med pr-b a dge.yml • WYSIWYG interf a ce for con f ig f ile gener a tion ❤ • Use https://shields.io/b a dges behind
- 8. Pull Request Badge Pros • E a sy, visu a l • Cool fe a tures (JIRA, b a dge with Link, common b a dge, br a nching, t a sks, l a bel) • Dyn a mic l a bel with e a sy API • Document a tion is a wesome • Dyn a mic during execution: If we click on a checkbox in the PR, the unckecked t a sk b a dge dis a ppe a rs in 1 sec. No need to l a unch the CI (s a me if we ch a nge the PR title for JIRA b a dge) ❤
- 9. Pull Request Badge Cons • Limited (by design, it’s not triggered by the CI), low number of b a dges • Single con f igur a tion only (c a n’t h a ve di ff erent B a dge for a PR hot f ix, PR rele a se or PR fe a ture • P a id (too expensive, a ccording the productivity g a in a nd limit a tions)
- 10. Create your own badge and create the opportunities
- 12. Custom PR badges The ingredients • https://shields.io/b a dges to get the st a tic b a dges gener a tor (free !) • https://simpleicons.org/ : Full icon ID a v a il a ble in shields.io (free !) • M a rkdown b a sic knowledge • API to a ccess your pull request re a d a nd write (gh for Github, gl a b for gitl a b) • C.I. system (Wh a tever) • Script shell • Ch a tGPT (or wh a tever, bec a use he is a m a zing in Shell a ssist a nce)
- 20. Custom PR badges Drawbacks • M a int a in code • Not re a ctive to PullRequest description ch a nge (unlike PRB a dge) except with GithubActions (on: [edited])
- 21. Custom PR badges Pros • Unlimited b a dge customis a tion • Enh a ncements (like getting the build number) • Sm a ll code b a se th a nks to cli (gh/gl a b) • Ch a tGPT re a lly strong to a ssist • Work on a ll CI a nd on Git Server (not only GitHub) • 3 sec of execution • The script is runn a ble in loc a l for testing
- 22. Going further • Github Actions -> Put the scripts before when the PullRequest ch a nges (= PRB a dge) • Put a new script a t the end of the pipeline to displ a y the cover a ge, the CI st a tus in a ddition • Ch a nge the script reg a rding the t a rget br a nch. For ex a mple if you w a nt speci f ic b a dge logic a g a inst a rele a se PR or hot f ix pr by using a speci f ic comment: <!—begin:WIP —!> etc… • Too in f inite a nd beyond
- 24. Questions ?