GitHub Action for automatic scheduled best-of list updates.

Getting Started • Support • Report a Bug • FAQ • Contribution • Changelog

The best-of update action is a Github Action for automated and scheduled updates of best-of markdown pages. It uses the best-of-generator CLI tool to generate and update a best-of markdown page from a list of projects configured in a yaml file. We also provide a full workflow definition which automatically creates pull requests and Github releases for every update.

🧙‍♂️ If you want to create your own best-of list, we strongly recommend to follow this guide. With the guide, it will only take about 3 minutes to get you started. It already includes this Github Action and some other useful template files. Further manual steps for setting up the Github Action are not required.

If you create a best-of list using the offical guide and template, the full workflow is already included without any further requirements from your side. If you want to manually set-up this Github Action (without the template), we recommend to use the update-best-of-list.yml workflow. It runs the best-of generator, auto-commits all changes into a separated branch, auto-creates a pull request as well as a draft release for the update. For integration into an existing workflow, please refer to this section. You can find documentation on the projects.yaml file and the markdown generation process in the best-of-generator documentation.

To use the update-best-of-list workflow, just copy this file into the .github/workflows/ folder of your repository. Once it is pushed into your repository, it will automatically run every seven days. You can also manually run this workflow by selecting: Actions -> update-best-of-list -> Run workflow (a version as input is not required).

In case you only want to use the best-of generator action itself to integrate it into an existing workflow, you can also just use the best-of-update-action as a step in your workflow, for example:

steps:
  - name: update-best-of-list
    uses: best-of-lists/[email protected]
    with:
      github_key: ${{ secrets.GITHUB_TOKEN }}
      libraries_key: ${{ secrets.LIBRARIES_KEY }}
      projects_file: "./projects.yaml"

If you want to enable the best-of generator to also fetch information from libraries.io, make sure to add your libraries API key as a secret to the repository with the name LIBRARIES_KEY.

You can find all channels for support, questions, and feedback in the best-of-generator documentation. If you have found a bug or want to request a feature, please open an issue in the best-of-generator repository since issues are deactivated in this repository.

Contributions are very welcome. You can find information on how to contribute to this project in the best-of-generator repository.

Refer to our contribution guides for detailed information on our build scripts and development process.

Licensed MIT. Created and maintained with ❤️  by developers from Berlin.