Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qjoly/nix-maintained_by
Github action to show in a md file which nix package you maintain
https://github.com/qjoly/nix-maintained_by
Last synced: 4 days ago
JSON representation
Github action to show in a md file which nix package you maintain
- Host: GitHub
- URL: https://github.com/qjoly/nix-maintained_by
- Owner: qjoly
- Created: 2023-05-09T17:22:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-17T12:20:41.000Z (30 days ago)
- Last Synced: 2025-01-11T11:53:50.089Z (5 days ago)
- Language: Python
- Homepage:
- Size: 43.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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:
```yaml
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:
```markdown
Anything here will be deleted
```
## Example of output
```md
## Nix Package maintained by @qjoly
- [aiac](https://github.com/gofireflyio/aiac/)
- [k9s](https://github.com/derailed/k9s)
```
- [aiac](https://github.com/gofireflyio/aiac/)
- [k9s](https://github.com/derailed/k9s)
## 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](LICENSE).