xin/nur
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

README: add github actions documentation

Browse source
This commit is contained in:
Jörg Thalheim 2020-08-13 08:48:38 +01:00
parent b6beae4e40
commit 391dd61e7c
No known key found for this signature in database
GPG key ID: 003F2096411B5F92
1 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -10,11 +10,11 @@
* Remember to mark the broken packages as `broken = true;` in the `meta` * Remember to mark the broken packages as `broken = true;` in the `meta`
attribute, or travis (and consequently caching) will fail! attribute, or travis (and consequently caching) will fail!
* Library functions, modules and overlays go in the respective directories * Library functions, modules and overlays go in the respective directories
3. Add your NUR repo name and your cachix repo name (optional) to 3. Choose your CI: Depending on your preference you can use github actions (recommended) or [Travis ci](https://travis-ci.com).
[.travis.yml](./.travis.yml) - Github actions: Change your NUR repo name and optionally add a cachix name in [.github/workflows/build.yml](./.github/workflows/build.yml) and change the cron timer
4. Enable travis for your repo to a random value as described in the file
* You can add a cron job in the repository settings on travis to keep your - Travis ci: Change your NUR repo name and optionally your cachix repo name in
cachix cache fresh [.travis.yml](./.travis.yml). Than enable travis in your repo. You can add a cron job in the repository settings on travis to keep your cachix cache fresh
5. Change your travis and cachix names on the README template section and delete 5. Change your travis and cachix names on the README template section and delete
the rest the rest
6. [Add yourself to NUR](https://github.com/nix-community/NUR#how-to-add-your-own-repository) 6. [Add yourself to NUR](https://github.com/nix-community/NUR#how-to-add-your-own-repository)
@ -25,7 +25,14 @@
**My personal [NUR](https://github.com/nix-community/NUR) repository** **My personal [NUR](https://github.com/nix-community/NUR) repository**
<!-- Remove this if you don't use github actions -->
![Build and populate cache](https://github.com/nix-community/<YOU-GITHUB-USER>/workflows/Build%20and%20populate%20cache/badge.svg)
<!--
Uncomment this if you use travis:
[![Build Status](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages.svg?branch=master)](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages) [![Build Status](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages.svg?branch=master)](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages)
-->
[![Cachix Cache](https://img.shields.io/badge/cachix-<YOUR_CACHIX_CACHE_NAME>-blue.svg)](https://<YOUR_CACHIX_CACHE_NAME>.cachix.org) [![Cachix Cache](https://img.shields.io/badge/cachix-<YOUR_CACHIX_CACHE_NAME>-blue.svg)](https://<YOUR_CACHIX_CACHE_NAME>.cachix.org)