Github

Bekijk op Github

GitHub is een ontwikkelaarsplatform dat ontwikkelaars in staat stelt om hun code te creëren, op te slaan en te beheren. Deze Github app richt zich op het verbinden van Github-gebeurtenissen en bestandsacties met het Blackbird-ecosysteem.

Voordat je begint

Voordat je verbinding kunt maken, moet je controleren of:

• Je een Github-account hebt.
• Je eigenaarsmachtigingen hebt voor de repository waarop je wilt automatiseren.

Verbinden

1. Navigeer naar apps en zoek naar Github. Als je Github niet kunt vinden, klik dan op Add App in de rechterbovenhoek, selecteer Github en voeg de app toe aan je Blackbird-omgeving.
2. Klik op Add Connection.
3. Geef je verbinding een naam voor toekomstige referentie, bijvoorbeeld ‘Mijn Github-verbinding’.
4. Klik op Authorize connection.
5. Volg de instructies die Github geeft, waarbij je Blackbird.io autoriseert om namens jou te handelen.
6. Wanneer je terugkeert naar Blackbird, controleer dan of de verbinding is verschenen en de status Connected is.

Gebeurtenissen instellen

Om te reageren op gebeurtenissen in Github moet je ook onze app op je repository installeren.

1. Ga naar de Blackbird app pagina op Github.
2. Klik op Configure
3. Selecteer de organisatie waar je Blackbird wilt installeren.
4. Selecteer All repositories of Only select repositories als je wilt beperken tot welke repositories Blackbird toegang heeft.

Actions

Repositories

• List repositories
• Create new repository
• Get repository
• Get repository issues
• List all repository content
• List repository folder content
• File exists

Branches

• List branches
• Get branch
• Merge branch

Commits

• List commits
• Get commit

Pull requests

• Create pull request
• List pull requests
• List pull request commits
• Get pull request
• Get repository pull requests
• Is pull request merged
• List pull request files
• Merge pull request

Files

• Get repository file
• Get all files in folder
• Get files by filepaths
• Delete file
• Create or update file
• Update file
• List added or modified files in X hours Invoerparameters:
  • “Repository ID”
  • “Last X hours” haalt toegevoegde of gewijzigde bestanden op die in de laatste X uur zijn gecommit
  • “Authors” filtert bestanden op auteurs die deze bestanden hebben toegevoegd/gewijzigd
  • “Exclude by authors” - stel in op “true” als je wijzigingen wilt uitsluiten die zijn gemaakt door gebruikers geselecteerd in het “Authors” veld
  • “Exclude merge commits” - stel in op “true” als je bestanden wilt uitsluiten die zijn toegevoegd/gewijzigd door een merge commit
• Download added or modified files in X hours as zip Dezelfde invoerparameters als in “List added or modified files in X hours”. Maar deze actie geeft je een ZIP-archief met de daadwerkelijke bestanden. Ook de mapstructuur blijft hetzelfde als in je repository
• Upload files in zip archive Actie om bestanden terug te uploaden naar je repository. Werkt samen met “Download added or modified files in X hours as zip”. De mapstructuur in het ZIP-archief wordt geprojecteerd op je repository. In het geval van een bestaand bestand wordt de inhoud bijgewerkt.

Users

• Get my user data
• Get user
• Get user by username

Utility

• Is file in folder

Events

Pulls

• On pull request action treedt op wanneer er activiteit is op een pull request. Zie deze pagina voor meer informatie.

Pushes

• On commit pushed treedt op wanneer er een push is naar een repository branch. Dit omvat wanneer een commit wordt gepusht, wanneer een commit-tag wordt gepusht, wanneer een branch wordt verwijderd, wanneer een tag wordt verwijderd, of wanneer een repository wordt gemaakt van een sjabloon.
• On files added wordt geactiveerd wanneer nieuwe commits nieuwe bestanden bevatten. Het geeft de paden naar alle toegevoegde bestanden terug.
• On files modified wordt geactiveerd wanneer nieuwe commits bestanden wijzigen. Het geeft paden naar alle gewijzigde bestanden terug.
• On files added or modified wordt geactiveerd wanneer nieuwe commits bestanden toevoegen of wijzigen. Het geeft paden naar al deze bestanden terug.
• On files removed wordt geactiveerd wanneer nieuwe commits bestanden verwijderen. Het geeft paden naar alle verwijderde bestanden terug.

Voor de bestandsspecifieke gebeurtenissen kan een padparameter worden opgegeven om de gebeurtenis te beperken tot alleen bestanden in specifieke mappen of bestanden met bepaalde extensies. Gebruik de forward slash ’/’ om de mapscheider weer te geven. Gebruik ’*’ om wildcards in bestands- en mapnamen weer te geven. Gebruik ’**’ om willekeurige mapdiepte weer te geven.

Bijvoorbeeld: wanneer je een gebeurtenis wilt maken die alleen wordt geactiveerd wanneer .html-bestanden worden gewijzigd in een map met de naam locales. Dan moet het pad van de On files added or modified gebeurtenis zijn: /locales/*.html

Voorbeeld

De volgende bird maakt een nieuw memoQ-project aan wanneer bestanden worden bijgewerkt of toegevoegd aan een specifieke map in een Github-repository.

Ontbrekende functies

We hebben de mogelijkheid om te triggeren op elke gebeurtenis die is gespecificeerd in deze lijst. Voel je vrij om deze bij ons aan te vragen.

Feedback

Wil je deze app gebruiken of heb je feedback op onze implementatie? Neem contact met ons op via de gevestigde kanalen of maak een issue aan.