devos-merge/230921 #25
2
.github/ISSUE_TEMPLATE/bug_report.md
vendored
2
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -35,4 +35,4 @@ Please search on the [issue tracker](../) before creating one.
|
||||||
|
|
||||||
## Your Environment
|
## Your Environment
|
||||||
<!--- Include relevant details about the environment you experienced the bug in. -->
|
<!--- Include relevant details about the environment you experienced the bug in. -->
|
||||||
<!--- If you have run `flk update`, for example, post the flake.lock file. -->
|
<!--- If you have run `bud update`, for example, post the flake.lock file. -->
|
||||||
|
|
2
.github/workflows/check.yml
vendored
2
.github/workflows/check.yml
vendored
|
@ -2,7 +2,7 @@ name: "Check & Cachix"
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- master
|
||||||
- trying
|
- trying
|
||||||
- staging
|
- staging
|
||||||
jobs:
|
jobs:
|
||||||
|
|
2
.github/workflows/mdbook_docs.yml
vendored
2
.github/workflows/mdbook_docs.yml
vendored
|
@ -3,7 +3,7 @@ name: Deploy Docs to GitHub Pages
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- master
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
deploy:
|
deploy:
|
||||||
|
|
4
.github/workflows/release.yml
vendored
4
.github/workflows/release.yml
vendored
|
@ -19,7 +19,7 @@ jobs:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
ref: core
|
ref: master
|
||||||
- name: Update Changelog
|
- name: Update Changelog
|
||||||
uses: heinrichreimer/github-changelog-generator-action@v2.1.1
|
uses: heinrichreimer/github-changelog-generator-action@v2.1.1
|
||||||
with:
|
with:
|
||||||
|
@ -49,7 +49,7 @@ jobs:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
ref: core
|
ref: master
|
||||||
|
|
||||||
- name: Get Changelog Entry
|
- name: Get Changelog Entry
|
||||||
id: changelog_reader
|
id: changelog_reader
|
||||||
|
|
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -2,7 +2,7 @@ result
|
||||||
.direnv
|
.direnv
|
||||||
doc/index.html
|
doc/index.html
|
||||||
|
|
||||||
# Result of flk commands
|
# Result of bud commands
|
||||||
vm
|
vm
|
||||||
iso
|
iso
|
||||||
doi
|
doi
|
||||||
|
|
|
@ -18,7 +18,7 @@ They also make [Nix expressions](https://nixos.org/manual/nix/unstable/expressio
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
Check out the [guide](https://devos.divnix.com/start) to get up and running.
|
Check out the [guide](https://devos.divnix.com/start) to get up and running.
|
||||||
Also, have a look at [_flake.nix_][toc]. If anything is not immediately
|
Also, have a look at [_flake.nix_](./flake.nix). If anything is not immediately
|
||||||
discoverable via "[`digga`][digga]'s [`mkFlake`][mk-flake],
|
discoverable via "[`digga`][digga]'s [`mkFlake`][mk-flake],
|
||||||
please file a bug report.
|
please file a bug report.
|
||||||
|
|
||||||
|
@ -88,3 +88,4 @@ DevOS is licensed under the [MIT License][mit].
|
||||||
[nixpkgs]: https://github.com/NixOS/nixpkgs
|
[nixpkgs]: https://github.com/NixOS/nixpkgs
|
||||||
[nvfetcher]: https://github.com/berberman/nvfetcher
|
[nvfetcher]: https://github.com/berberman/nvfetcher
|
||||||
[please]: https://github.com/nrdxp/devos/tree/nrd
|
[please]: https://github.com/nrdxp/devos/tree/nrd
|
||||||
|
[matrix]: https://matrix.to/#/#devos:nixos.org
|
||||||
|
|
|
@ -1 +1 @@
|
||||||
nix flake new -t "github:divnix/devos/core" "${2:-devos}"
|
nix flake new -t "github:divnix/devos/master" "${2:-devos}"
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
# Pull Requests
|
# Pull Requests
|
||||||
|
|
||||||
## TL;DR;
|
## TL;DR;
|
||||||
- **Target Branch**: `main`
|
- **Target Branch**: `master`
|
||||||
- **Merge Policy**: [`bors`][bors] is alwyas right (→ `bors try`)
|
- **Merge Policy**: [`bors`][bors] is always right (→ `bors try`)
|
||||||
- **Docs**: every changeset is expected to contain doc updates
|
- **Docs**: every changeset is expected to contain doc updates
|
||||||
- **Commit Msg**: be a poet! Comprehensive and explanatory commit messages
|
- **Commit Msg**: be a poet! Comprehensive and explanatory commit messages
|
||||||
should cover the motivation and use case in an easily understandable manner
|
should cover the motivation and use case in an easily understandable manner
|
||||||
|
|
|
@ -63,5 +63,5 @@ specific belongs in your [host](hosts.md) files instead.
|
||||||
[definition]: https://nixos.org/manual/nixos/stable/index.html#sec-option-definitions
|
[definition]: https://nixos.org/manual/nixos/stable/index.html#sec-option-definitions
|
||||||
[declaration]: https://nixos.org/manual/nixos/stable/index.html#sec-option-declarations
|
[declaration]: https://nixos.org/manual/nixos/stable/index.html#sec-option-declarations
|
||||||
[options]: https://nixos.org/manual/nixos/stable/index.html#sec-writing-modules
|
[options]: https://nixos.org/manual/nixos/stable/index.html#sec-writing-modules
|
||||||
[spec]: https://github.com/divnix/devos/tree/core/lib/devos/mkProfileAttrs.nix
|
[spec]: https://github.com/divnix/devos/tree/master/lib/devos/mkProfileAttrs.nix
|
||||||
[config]: https://nixos.wiki/wiki/Module#structure
|
[config]: https://nixos.wiki/wiki/Module#structure
|
||||||
|
|
|
@ -48,7 +48,7 @@ argument that gets passed to your home-manager users.
|
||||||
|
|
||||||
## External Usage
|
## External Usage
|
||||||
You can easily use the defined home-manager configurations outside of NixOS
|
You can easily use the defined home-manager configurations outside of NixOS
|
||||||
using the `homeConfigurations` flake output. The [flk](../flk/index.md) helper
|
using the `homeConfigurations` flake output. The [bud](../bud/index.md) helper
|
||||||
script makes this even easier.
|
script makes this even easier.
|
||||||
|
|
||||||
This is great for keeping your environment consistent across Unix systems,
|
This is great for keeping your environment consistent across Unix systems,
|
||||||
|
@ -57,10 +57,10 @@ including OSX.
|
||||||
### From within the projects devshell:
|
### From within the projects devshell:
|
||||||
```sh
|
```sh
|
||||||
# builds the nixos user defined in the NixOS host
|
# builds the nixos user defined in the NixOS host
|
||||||
flk home NixOS nixos
|
bud home NixOS nixos
|
||||||
|
|
||||||
# build and activate
|
# build and activate
|
||||||
flk home NixOS nixos switch
|
bud home NixOS nixos switch
|
||||||
```
|
```
|
||||||
|
|
||||||
### Manually from outside the project:
|
### Manually from outside the project:
|
||||||
|
@ -73,5 +73,5 @@ nix build "github:divnix/devos#homeConfigurations.nixos@NixOS.home.activationPac
|
||||||
```
|
```
|
||||||
|
|
||||||
[home-manager]: https://nix-community.github.io/home-manager
|
[home-manager]: https://nix-community.github.io/home-manager
|
||||||
[modules-list]: https://github.com/divnix/devos/tree/core/users/modules/module-list.nix
|
[modules-list]: https://github.com/divnix/devos/tree/master/users/modules/module-list.nix
|
||||||
[portableuser]: https://digga.divnix.com/api-reference-home.html#homeusers
|
[portableuser]: https://digga.divnix.com/api-reference-home.html#homeusers
|
||||||
|
|
|
@ -40,7 +40,7 @@ And the private key to your user:
|
||||||
|
|
||||||
And run the deployment:
|
And run the deployment:
|
||||||
```sh
|
```sh
|
||||||
deploy "flk#hostName" --hostname host.example.com
|
deploy '.#hostName' --hostname host.example.com
|
||||||
```
|
```
|
||||||
|
|
||||||
> ##### _Note:_
|
> ##### _Note:_
|
||||||
|
|
|
@ -40,4 +40,4 @@ fetch.git = "https://github.com/mlvzk/manix.git" # responsible for fetching
|
||||||
|
|
||||||
[nvf]: https://github.com/berberman/nvfetcher
|
[nvf]: https://github.com/berberman/nvfetcher
|
||||||
[nvf-readme]: https://github.com/berberman/nvfetcher#readme
|
[nvf-readme]: https://github.com/berberman/nvfetcher#readme
|
||||||
[sources.toml]: https://github.com/divnix/devos/tree/core/pkgs/sources.toml
|
[sources.toml]: https://github.com/divnix/devos/tree/master/pkgs/sources.toml
|
||||||
|
|
|
@ -4,7 +4,7 @@
|
||||||
Assuming you're happy with your existing partition layout, you can generate a
|
Assuming you're happy with your existing partition layout, you can generate a
|
||||||
basic NixOS configuration for your system using:
|
basic NixOS configuration for your system using:
|
||||||
```sh
|
```sh
|
||||||
flk up
|
bud up
|
||||||
```
|
```
|
||||||
|
|
||||||
This will make a new file `hosts/up-$(hostname).nix`, which you can edit to
|
This will make a new file `hosts/up-$(hostname).nix`, which you can edit to
|
||||||
|
@ -38,7 +38,7 @@ Now might be a good time to read the docs on [suites](../concepts/suites.md) and
|
||||||
|
|
||||||
Once you're ready to deploy `hosts/my-host.nix`:
|
Once you're ready to deploy `hosts/my-host.nix`:
|
||||||
```sh
|
```sh
|
||||||
flk my-host switch
|
bud my-host switch
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -6,10 +6,10 @@ Here is a snippet that will get you the template without the git history:
|
||||||
```sh
|
```sh
|
||||||
nix-shell -p cachix --run "cachix use nrdxp"
|
nix-shell -p cachix --run "cachix use nrdxp"
|
||||||
|
|
||||||
nix-shell https://github.com/divnix/devos/archive/core.tar.gz -A shell \
|
nix-shell https://github.com/divnix/devos/archive/master.tar.gz -A shell \
|
||||||
--run "flk get core"
|
--run "bud get master"
|
||||||
|
|
||||||
cd flk
|
cd devos
|
||||||
|
|
||||||
nix-shell
|
nix-shell
|
||||||
|
|
||||||
|
@ -18,7 +18,7 @@ git add .
|
||||||
git commit -m init
|
git commit -m init
|
||||||
```
|
```
|
||||||
|
|
||||||
This will place you in a new folder named `flk` with git initialized, and a
|
This will place you in a new folder named `devos` with git initialized, and a
|
||||||
nix-shell that provides all the dependencies, including the unstable nix
|
nix-shell that provides all the dependencies, including the unstable nix
|
||||||
version required.
|
version required.
|
||||||
|
|
||||||
|
|
|
@ -26,7 +26,7 @@ and the examples in [nixpkgs][nixos-tests].
|
||||||
|
|
||||||
[test-doc]: https://nixos.org/manual/nixos/stable/index.html#sec-nixos-tests
|
[test-doc]: https://nixos.org/manual/nixos/stable/index.html#sec-nixos-tests
|
||||||
[test-blog]: https://www.haskellforall.com/2020/11/how-to-use-nixos-for-lightweight.html
|
[test-blog]: https://www.haskellforall.com/2020/11/how-to-use-nixos-for-lightweight.html
|
||||||
[default]: https://github.com/divnix/devos/tree/core/tests/default.nix
|
[default]: https://github.com/divnix/devos/tree/master/tests/default.nix
|
||||||
[run-test]: https://github.com/NixOS/nixpkgs/blob/6571462647d7316aff8b8597ecdf5922547bf365/lib/debug.nix#L154-L166
|
[run-test]: https://github.com/NixOS/nixpkgs/blob/6571462647d7316aff8b8597ecdf5922547bf365/lib/debug.nix#L154-L166
|
||||||
[nixos-tests]: https://github.com/NixOS/nixpkgs/tree/master/nixos/tests
|
[nixos-tests]: https://github.com/NixOS/nixpkgs/tree/master/nixos/tests
|
||||||
[testing-python]: https://github.com/NixOS/nixpkgs/tree/master/nixos/lib/testing-python.nix
|
[testing-python]: https://github.com/NixOS/nixpkgs/tree/master/nixos/lib/testing-python.nix
|
||||||
|
|
Loading…
Reference in a new issue