Issuer — GitHub-app för tvingad självbetjäning av användare i repot

Inom ramen för projektet Utgivare En bot har förberetts för GitHub som löser problem med att tvinga användare av förvaret att självbetjäna sig. På GitHub kan man stöta på förvar som har som enda funktion att koordinera människor genom systemet Issue. I vissa av dessa uppmanas de som lämnar Issue att fylla i ett formulär. Därefter kommer en moderator, kontrollerar om formuläret är korrekt ifyllt och sätter taggar enligt de som angivits i formuläret (taggarna kan endast sättas av en privilegierad användare om de inte är angivna i mallen). Ett exempel på en sådan gemenskap är open-source-ideas/open-source-ideas.

Moderatoren kommer inte omedelbart. Därför för att kontrollera formulär och utföra åtgärder förberedd presenteras den GitHub-åtgärd som nämns i nyheterna. Botten är skriven i Python, men man måste ändå köra den genom node.js eftersom GitHub har endast 2 typer av åtgärder — node.js och docker, och för docker måste man först ladda ner den samma containern där node.js finns, och i den laddas ytterligare en container, vilket tar tid. Med tanke på att containern med node.js redan har python3 och allt annat som behövs, är det rationellt att helt enkelt ladda ner beroenden i den, eftersom de är små.

Egenskaper:

• Åtgärden styrs med hjälp av YAML-konfiguration och Markdown-mallar;
• I varje Markdown-mall läggs en sektion till som beskriver villkoren för korrekt ifyllande av formuläret och önskade åtgärder;
• En konfigurationsfil med globala inställningar läggs till;
• Formulär består av sektioner. Det finns 2 typer av sektioner:
  • Fritt text. Åtgärden kan kontrollera att användaren har ansträngt sig för att fylla i något där. Men meningsfullheten av texten kontrolleras automatiskt inte.
  • Kryssrutor (checkbox). Man kan kräva att fylla i n kryssrutor, sådana att 0 {= m1 {= n {= m2 {= det totala antalet kryssrutor i sektionen. Åtgärden kontrollerar att kryssrutorna överensstämmer med kryssrutorna i mallen. Om kryssrutorna är korrekt angivna kan åtgärden sätta taggar på issue som motsvarar kryssrutorna.
• Om formuläret är felaktigt ifyllt instruerar åtgärden användaren hur det ska fyllas i korrekt och sätter en speciell märkning.
• Om formuläret inte rättas till inom viss tid kan åtgärden stänga issue. Automatisk ban av användare, radering och flyttning av issue har inte implementerats på grund av avsaknad av officiell API för nödvändiga åtgärder och problem med lagring av tillstånd.
• Om problemet har åtgärdats, tar åtgärden bort märkningen.
• Svarsmallar för åtgärder kan självklart anpassas.

Källa: opennet.ru