GitHub Action to dynamically update CONTRIBUTORS file

Related tags

Third Party APIs action-contributors
Overview

Generate / Update CONTRIBUTORS File - GitHub Action

This GitHub Action updates a CONTRIBUTORS file with the top contributors from the specified project, pulling contents from the GitHub API.

Example Usage

This action is made to use in conjunction with test-room-7/action-update-file in order to automatically commit an updated CONTRIBUTORS file in a fixed interval.

The following example sets a workflow to update the file once a month:

name: Update CONTRIBUTORS file
on:
  schedule:
    - cron: "0 0 1 * *"
  workflow_dispatch:
jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - uses: minicli/action-contributors@v2
        name: 'Update a projects CONTRIBUTORS file'
      - name: Update resources
        uses: test-room-7/action-update-file@v1
        with:
          file-path: 'CONTRIBUTORS.md'
          commit-msg: Update Contributors
          github-token: ${{ secrets.GITHUB_TOKEN }}
        env:
          CONTRIB_REPOSITORY: 'minicli/minicli'
          CONTRIB_OUTPUT_FILE: 'CONTRIBUTORS.md'
Comments
  • Wrong GitHub profile link

    Wrong GitHub profile link

    After using your action (thank you very much for automating this task), the profile links in the CONTRIBUTORS.md are broken. They point to an API call instead of the profile page:

    Actual: https://api.github.com/users/McPringle Expected: https://github.com/McPringle

    As a result, if the viewer of the file clicks on the GitHub username, he will get a JSON file instead of the expected profile page.

    opened by McPringle 2
  • Custom template not working

    Custom template not working

    The directions to set up a custom template are not working as expected. Stencil expects a template directory that must be set before setting the template name. We'll need a second ENV var to set the directory, otherwise we'll need to change how Stencil works.

    Working on it.

    opened by erikaheidi 1
  • return error if contrib repository not set

    return error if contrib repository not set

    I created this PR because if you don't set the CONTRIB_REPOSITORY or you create a wrong workflow file, this tool uses the default minicli/minicli and you can create/edit the contributors file with the wrong data. (it happens to me in an open-source library).

    What do you think?

    opened by AlessandroMinoccheri 1
  • Filter renovate-bot

    Filter renovate-bot

    Please filter the @renovate-bot from the contributors. Or add a configuration option to configure usernames to exclude (there might be a lot more bot out there).

    opened by McPringle 1
  • Missing the Code of Conduct

    Missing the Code of Conduct

    Hello, This project is currently missing the Code of Conduct. I am not sure if you would be interested in adding one, but if you do, then please let me know so that I can add a PR for that. And yeah, in that case, I would also need an address (email address) for adding that in the Code of Conduct file.

    opened by FahimFBA 1
  • Breaking the action into two repositories?

    Breaking the action into two repositories?

    Currently, the app that is executed within this GitHub Action is self-contained within the Action repository. This was convenient at first, but if the app gains more features and starts to become more complex, I'm starting to think that it would be better to have it on its own repository. Maybe some people would rather run the app manually or on a self-hosted environment.

    Anyone has thoughts on that?

    opened by erikaheidi 0
  • Guide to run project locally

    Guide to run project locally

    No doubt the project is is great, just the issue is PHP is not everyone's cup of tea.

    Can you please add a guide how can we run/test the project locally and make the changes to get a more effective and beautiful contributors.md file.

    Right now I just have an idea to add a check on workflow of the action to check and commit changes to the contributors.md file only if there's a new contributor added to the mentioned repository otherwise just pass the workflow. But it would be great for all of us if you could add a guide to run this project locally so that we can also contribute to it.

    (I am assuming that this check is not added yet because of the same reason PHP xD)

    documentation good first issue hacktoberfest 
    opened by HemantSachdeva 1
  • Suggested feature: Last contribution

    Suggested feature: Last contribution

    Just saw this on LinkedIn. Surprised to see some PHP in here. Hello 👋 😆

    One thing I notice in some repo's is that it's hard to see who is an active contributor, versus a legacy maintainer, who may have lost interest in a project. This can lead to legacy maintainers getting contacted about projects they are no longer involved in, and confusion as to who the active and current team are.

    It would be interesting if there was a way to show the last contribution date (maybe even PR) in the generated contributors file.

    I don't expect this to be added. It's just an idea, and I wondered if placing it here might see interest from others. Thank you.

    enhancement 
    opened by Lewiscowles1986 1
Releases(v3.3)

  • v3.3(Oct 7, 2022)

  • v3.2.3(Oct 7, 2022)

    This version uses a new base image that is tailored to execute curl requests with Minicli.

    Full Changelog: https://github.com/minicli/action-contributors/compare/v3.2.2...v3.2.3

    Source code(tar.gz)
    Source code(zip)

  • v3.2.2(Oct 7, 2022)

    What's Changed

    • #9 Fixed stencil template settings by @erikaheidi in https://github.com/minicli/action-contributors/pull/10

    Full Changelog: https://github.com/minicli/action-contributors/compare/v3.2.1...v3.2.2

    Source code(tar.gz)
    Source code(zip)

  • v3.2.1(Oct 7, 2022)

    What's Changed

    • added stencil templates to better customize generated markdown file by @erikaheidi
    • added env var to customize ignored users by @erikaheidi
    • return error if contrib repository not set by @AlessandroMinoccheri in https://github.com/minicli/action-contributors/pull/8
    • Upgrade examples to v3.1 by @McPringle in https://github.com/minicli/action-contributors/pull/3

    New Contributors

    • @AlessandroMinoccheri made their first contribution in https://github.com/minicli/action-contributors/pull/8
    • @McPringle made their first contribution in https://github.com/minicli/action-contributors/pull/3

    Full Changelog: https://github.com/minicli/action-contributors/compare/v3.2...v3.2.1

    Source code(tar.gz)
    Source code(zip)

  • v3.2(Oct 7, 2022)

  • v3.1(Dec 18, 2021)

    Version 3.1 includes a check to ignore a list of users (by default including the GH actions bot) and fixes the user profile URL for the web version.

    Source code(tar.gz)
    Source code(zip)
Owner
minicli
Minimalist CLI-centric PHP microframework
minicli
GitHub
A simple PHP GitHub API client, Object Oriented, tested and documented.

PHP GitHub API A simple Object Oriented wrapper for GitHub API, written with PHP. Uses GitHub API v3 & supports GitHub API v4. The object API (v3) is

KNP Labs 2k Jan 7, 2023
PHP library for the GitHub API v3

GitHub API v3 - PHP Library Currently under construction. Overview Provides access to GitHub API v3 via an Object Oriented PHP library. The goal of th

Darren Rees 62 Jul 28, 2022
A GitHub API bridge for Laravel

Laravel GitHub Laravel GitHub was created by, and is maintained by Graham Campbell, and is a PHP GitHub API bridge for Laravel. It utilises my Laravel

Graham Campbell 547 Dec 30, 2022
Retrieve the GitHub Sponsors of a given user/organization.

Laravel GitHub Sponsors Retrieve the GitHub Sponsors of any user/organization and check if someone is sponsoring you. Installation composer require as

Astrotomic 7 Apr 27, 2022
Generate pretty release changelogs using the commit log and Github API.

zenstruck/changelog Generate pretty release changelogs using the commit log and Github API. Changelog entries are in the following format: {short hash

Kevin Bond 3 Jun 20, 2022
A discord bot for creating github repo issues.

Discord Issue Bot A discord bot for creating github repo issues. Requires: php-zlib, php-json, mysql, composer Tested on: Ubuntu 20.04.3, PHP Version

null 1 Jan 20, 2022
âš¡ Dynamically generated, customizable SVG that gives the appearance of typing and deleting text. Typing SVGs can be used as a bio on your Github profile readme or repository.

âš¡ Dynamically generated, customizable SVG that gives the appearance of typing and deleting text. Typing SVGs can be used as a bio on your Github profile readme or repository.

Jonah Lawrence 2k Jan 9, 2023
SlimJim was born out of a need for a simple auto update script which would update multiple development/test environments every time someone

SlimJim WHY? SlimJim was born out of a need for a simple auto update script which would update multiple development/test environments every time someo

Jesal Gadhia 100 Apr 22, 2022
GitHub action to setup PHP with required extensions, php.ini configuration, code-coverage support and various tools like composer...

Setup PHP in GitHub Actions Setup PHP with required extensions, php.ini configuration, code-coverage support and various tools like composer in GitHub

Shivam Mathur 2.4k Jan 6, 2023
GitHub action to setup PHP with required extensions, php.ini configuration, code-coverage support and various tools like composer...

Setup PHP in GitHub Actions Setup PHP with required extensions, php.ini configuration, code-coverage support and various tools like composer in GitHub

Shivam Mathur 2.4k Jan 6, 2023
GitHub Action that diffs composer.lock between current branch and default branch

github-action-composer.lock-diff GitHub Action that diffs composer.lock between current branch and default branch Options (inputs) This action support

Cees-Jan Kiewiet 13 Oct 31, 2022
GitHub action to set up PHP with extensions, php.ini configuration, coverage drivers, and various tools.

GitHub action to set up PHP with extensions, php.ini configuration, coverage drivers, and various tools.

Shivam Mathur 2.4k Jan 6, 2023
🤖 GitHub Action to run symfony console commands.

Symfony Console GitHub Action Usage You can use it as a Github Action like this: # .github/workflows/lint.yml name: "Lint" on: pull_request: push

Nucleos 3 Oct 20, 2022
Github Action which checks Security issues scanning package manager files

security-checker-action This action checks your composer.lock for known vulnerabilities in your package dependencies. Inputs lock optional The path to

Druid 0 May 5, 2022
File Upload widget with multiple file selection, drag&drop support, progress bar, validation and preview images, audio and video for jQuery. Supports cross-domain, chunked and resumable file uploads. Works with any server-side platform (Google App Engine, PHP, Python, Ruby on Rails, Java, etc.) that supports standard HTML form file uploads.

jQuery File Upload Contents Description Demo Features Security Setup Requirements Mandatory requirements Optional requirements Cross-domain requiremen

Sebastian Tschan 31.1k Jan 8, 2023
This package provides some basic methods to implement a self updating functionality for your Laravel application. Already bundled are some methods to provide a self-update mechanism via Github or some private repository via http.

This package provides some basic methods to implement a self updating functionality for your Laravel 5 application. Already bundled are some methods to provide a self-update mechanism via Github.

Holger Lösken 311 Dec 31, 2022
This WP plugin will update GitHub, Bitbucket, GitLab, and Gitea hosted plugins and themes

Transition from GitHub Updater 9.x to Git Updater 10.x Due to the renaming of the plugin folders and files, after the initial update, the plugin will

Andy Fragen 3k Jan 5, 2023
A PHP GD + TwitterOAuth demo to dynamically generate Twitter header images and upload them via the API.

A PHP GD + TwitterOAuth demo to dynamically generate Twitter header images and upload them via the API. This enables you to build cool little tricks, like showing your latest followers or sponsors, latest content creted, a qrcode to something, a progress bar for some goal, and whathever you can think of.

Erika Heidi 172 Jan 5, 2023
a laravel package to create dynamically dashboard views in several templates ( in development)

Laravel Dashboarder A laravel package for generate admin dashboard dynamically based on Tabler template use livewire - alpinejs Installation Run the c

Laravel Iran Community 7 Dec 12, 2022
Laravel-htaccess - a package for dynamically edit .htaccess in laravel

laravel-htaccess a package for dynamically edit .htaccess in laravel use RedirectHtaccess Facade function for add RedirectHtaccess()->add(); return in

Mohammad khazaee 3 Dec 19, 2021