Git Product home page Git Product logo

nix-maintained_by's Introduction

Nix ‘Maintained by’

This Github action module will display the packages maintained by a certain user.

Usage

To use this GitHub Action, you’ll need to create a workflow file in your repository’s .github/workflows directory. For example, you could create a file called maintained_by_qjoly.yml with the following contents:

name: Run action on test.md

on:
  push:
    branches:
      - main
jobs:
  run_action:
    runs-on: ubuntu-latest
    name: Run 'Nix-Maintained_by'
    steps:
      - uses: actions/checkout@v3 # Clone your code
      
      - uses: actions/checkout@v3 # Clone NixPkgs
        with:
          path: './nixpkgs'
          repository: 'NixOS/nixpkgs'
      
      - name: Run nix-maintainers-get-packages # Run action 
        uses: qjoly/[email protected]
        with:
          file: './test.md'
          path_nixpkgs: './nixpkgs/pkgs'
          maintainer: 'qjoly'

This workflow specifies that it should be triggered on push events. The job has three steps:

  1. Check out your repository using the actions/checkout action.
  2. Check out the repository NixOS/nixpkgs using the actions/checkout action.
  3. Run the Github action qjoly/[email protected] to find which packages are maintained by maintainer and write the result in test.md. The markdown file will be commited and pushed

To put the package list, the test.md file must contain the following markers:

<!-- NIX-PACKAGES:START -->
Anything here will be deleted
<!-- NIX-PACKAGES:END -->

Example of output

## Nix Package maintained by @qjoly

<!-- NIX-PACKAGES:START -->
- [aiac](https://github.com/gofireflyio/aiac/)
- [k9s](https://github.com/derailed/k9s)
<!-- NIX-PACKAGES:END -->

Inputs

file

Required The markdown file where the output will be writed

path_nixpkgs

Required The path to the repository NixOS/nixpkgs

Maintainer

Required The maintainer name

Outputs

This GitHub Action does not have any outputs.

License

This GitHub Action is licensed under the MIT License.

nix-maintained_by's People

Contributors

github-actions[bot] avatar qjoly avatar renovate[bot] avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.