Skip to content

Commit ccb2d87

Browse files
committed
Update README and configure CI properly
1 parent 202c36e commit ccb2d87

File tree

2 files changed

+11
-31
lines changed

2 files changed

+11
-31
lines changed

.github/workflows/build.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@ on:
44
push:
55
branches:
66
- main
7-
- master
87
schedule:
98
# rebuild everyday at 2:51
109
# TIP: Choose a random time here so not all repositories are build at once:
1110
# https://www.random.org/clock-times/?num=1&earliest=01%3A00&latest=08%3A00&interval=5&format=html&rnd=new
12-
- cron: '51 2 * * *'
11+
- cron: '55 4 * * *'
1312
jobs:
1413
tests:
1514
strategy:
@@ -20,7 +19,7 @@ jobs:
2019
# The repo name as used in
2120
# https://github.com/nix-community/NUR/blob/master/repos.json
2221
nurRepo:
23-
- <YOUR_REPO_NAME>
22+
- nixathena
2423
# Set this to cache your build results in cachix for faster builds
2524
# in CI and for everyone who uses your cache.
2625
#
@@ -32,7 +31,7 @@ jobs:
3231
# Github found at
3332
# https://github.com/<your_githubname>/nur-packages/settings/secrets
3433
cachixName:
35-
- <YOUR_CACHIX_NAME>
34+
- nixathena
3635
nixPath:
3736
- nixpkgs=https://github.com/NixOS/nixpkgs/archive/refs/heads/nixpkgs-unstable.tar.gz
3837
- nixpkgs=https://github.com/NixOS/nixpkgs/archive/refs/heads/nixos-unstable.tar.gz
@@ -71,5 +70,6 @@ jobs:
7170
run: nix shell -f '<nixpkgs>' nix-build-uncached -c nix-build-uncached ci.nix -A cacheOutputs
7271
- name: Trigger NUR update
7372
# Don't replace <YOUR_REPO_NAME> here!
74-
if: ${{ matrix.nurRepo != '<YOUR_REPO_NAME>' }}
73+
# AWD: Added false because I haven't actually registered this repo yet
74+
if: ${{ matrix.nurRepo != '<YOUR_REPO_NAME>' && false }}
7575
run: curl -XPOST "https://nur-update.nix-community.org/update?repo=${{ matrix.nurRepo }}"

README.md

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,17 @@
1-
# nur-packages-template
1+
# Nixathena
22

3-
**A template for [NUR](https://github.com/nix-community/NUR) repositories**
3+
This is Nixathena, a vague start at a package repo for using MIT Athena on [NixOS](https://nixos.org/), inspired by [Debathena](https://debathena.mit.edu/).
44

5-
## Setup
5+
Eventually I may [add it](https://github.com/nix-community/NUR#how-to-add-your-own-repository) as a [Nix User Repository](https://github.com/nix-community/NUR) (and have used that template), but I don't think it's stable enough for that yet.
66

7-
1. Click on [Use this template](https://github.com/nix-community/nur-packages-template/generate) to start a repo based on this template. (Do _not_ fork it.)
8-
2. Add your packages to the [pkgs](./pkgs) directory and to
9-
[default.nix](./default.nix)
10-
* Remember to mark the broken packages as `broken = true;` in the `meta`
11-
attribute, or travis (and consequently caching) will fail!
12-
* Library functions, modules and overlays go in the respective directories
13-
3. Choose your CI: Depending on your preference you can use github actions (recommended) or [Travis ci](https://travis-ci.com).
14-
- 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
15-
to a random value as described in the file
16-
- Travis ci: Change your NUR repo name and optionally your cachix repo name in
17-
[.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
18-
5. Change your travis and cachix names on the README template section and delete
19-
the rest
20-
6. [Add yourself to NUR](https://github.com/nix-community/NUR#how-to-add-your-own-repository)
21-
22-
## README template
23-
24-
# nur-packages
25-
26-
**My personal [NUR](https://github.com/nix-community/NUR) repository**
7+
## CI status
278

289
<!-- Remove this if you don't use github actions -->
29-
![Build and populate cache](https://github.com/<YOUR-GITHUB-USER>/nur-packages/workflows/Build%20and%20populate%20cache/badge.svg)
10+
![Build and populate cache](https://github.com/dehnert/nixathena/workflows/Build%20and%20populate%20cache/badge.svg)
3011

3112
<!--
3213
Uncomment this if you use travis:
3314
3415
[![Build Status](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages.svg?branch=master)](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages)
3516
-->
36-
[![Cachix Cache](https://img.shields.io/badge/cachix-<YOUR_CACHIX_CACHE_NAME>-blue.svg)](https://<YOUR_CACHIX_CACHE_NAME>.cachix.org)
37-
17+
[![Cachix Cache](https://img.shields.io/badge/cachix-nixathena-blue.svg)](https://nixathena.cachix.org)

0 commit comments

Comments
 (0)