best-of-update-action

KO | EN

gitlite — search

#python #hacktoberfest #react #android #deep-learning #macos #java #windows #cli #kubernetes #pytorch #security #openai #open-source

best-of-update-action

(★ 15)

🔄 GitHub Action to update a best-of list.

best-of-update-action Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">
    best-of-update-action
</h1>

<p align="center">
    <strong>GitHub Action for automatic scheduled best-of list updates.</strong>
</p>

<p align="center">
  <a href="#getting-started">Getting Started</a> •
  <a href="#support--feedback">Support</a> •
  <a href="https://github.com/best-of-lists/best-of-generator/issues/new?labels=bug&template=01_bug-report.md">Report a Bug</a> •
  <a href="#faq">FAQ</a> •
  <a href="#contribution">Contribution</a> •
  <a href="https://github.com/best-of-lists/best-of-update-action/releases">Changelog</a>
</p>

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](https://github.com/best-of-lists/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.

## Getting Started

> 🧙‍♂️ If you want to create your own best-of list, we strongly recommend to follow [this guide](https://github.com/best-of-lists/best-of/blob/main/create-best-of-list.md). 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](#TODO), 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](https://github.com/best-of-lists/best-of-update-action/blob/main/workflows/update-best-of-list.yml). 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](#integrate-into-existing-workflow). You can find documentation on the `projects.yaml` file and the markdown generation process in the [best-of-generator documentation](https://github.com/best-of-lists/best-of-generator#documentation).

#### Using the full workflow

To use the `update-best-of-list` workflow, just copy [this file](https://github.com/best-of-lists/best-of-update-action/blob/main/workflows/update-best-of-list.yml) 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)_.

#### Integrate into existing workflow

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:

```yaml
steps:
  - name: update-best-of-list
    uses: best-of-lists/best-of-update-action@v0.8.5
    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](https://libraries.io), make sure to add your libraries API key as a secret to the repository with the name `LIBRARIES_KEY`.

## Support & Feedback

You can find all channels for support, questions, and feedback in the [best-of-generator documentation](https://github.com/best-of-lists/best-of-generator#support--feedback). If you have found a bug or want to request a feature, please open an issue in the [best-of-generator repository](https://github.com/best-of-lists/best-of-generator/issues/new/choose) since issues are deactivated in this repository.

## Contribution

Contributions are very welcome. You can find information on how to contribute to this project in the [best-of-generator repository](https://github.com/best-of-lists/best-of-generator#contribution).

## Development

Refer to our [contribution guides](https://github.com/best-of-lists/best-of-update-action/blob/main/CONTRIBUTING.md#development-instructions) for detailed information on our build scripts and development process.

---

Licensed **MIT**. Created and maintained with ❤️&nbsp; by developers from Berlin.

best-of-update-action

best-of-update-action Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

best-of-update-action

best-of-update-action Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README