Skip to content

Commit 4e4c898

Browse files
committed
arrival of botpkgs
1 parent 9cd896f commit 4e4c898

File tree

426 files changed

+903
-903
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

426 files changed

+903
-903
lines changed

.github/CODEOWNERS

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
/lib/tests/modules.sh @infinisil @roberth
3535
/lib/tests/modules @infinisil @roberth
3636

37-
# Nixpkgs Internals
37+
# Botpkgs Internals
3838
/default.nix @Ericson2314
3939
/pkgs/top-level/default.nix @Ericson2314
4040
/pkgs/top-level/impure.nix @Ericson2314
@@ -59,18 +59,18 @@
5959
/pkgs/top-level/by-name-overlay.nix @infinisil
6060
/.github/workflows/check-by-name.yml @infinisil
6161

62-
# Nixpkgs build-support
62+
# Botpkgs build-support
6363
/pkgs/build-support/writers @lassulus @Profpatsch
6464

65-
# Nixpkgs make-disk-image
65+
# Botpkgs make-disk-image
6666
/doc/build-helpers/images/makediskimage.section.md @raitobezarius
6767
/botnix/lib/make-disk-image.nix @raitobezarius
6868

6969
# Nix, the package manager
7070
pkgs/tools/package-management/nix/ @raitobezarius @ma27
7171
botnix/modules/installer/tools/nix-fallback-paths.nix @raitobezarius @ma27
7272

73-
# Nixpkgs documentation
73+
# Botpkgs documentation
7474
/maintainers/scripts/db-to-md.sh @jtojnar @ryantm
7575
/maintainers/scripts/doc @jtojnar @ryantm
7676

.github/ISSUE_TEMPLATE/missing_documentation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Missing or incorrect documentation
3-
about: Help us improve the Nixpkgs and Botnix reference manuals
3+
about: Help us improve the Botpkgs and Botnix reference manuals
44
title: 'Documentation: '
55
labels: '9.needs: documentation'
66
assignees: ''
@@ -19,11 +19,11 @@ assignees: ''
1919

2020
<!-- make sure this issue is not redundant or obsolete -->
2121

22-
- [ ] checked [latest Nixpkgs manual] \([source][nixpkgs-source]) and [latest Botnix manual] \([source][nixos-source])
22+
- [ ] checked [latest Botpkgs manual] \([source][nixpkgs-source]) and [latest Botnix manual] \([source][nixos-source])
2323
- [ ] checked [open documentation issues] for possible duplicates
2424
- [ ] checked [open documentation pull requests] for possible solutions
2525

26-
[latest Nixpkgs manual]: https://nixos.org/manual/nixpkgs/unstable/
26+
[latest Botpkgs manual]: https://nixos.org/manual/nixpkgs/unstable/
2727
[latest Botnix manual]: https://nixos.org/manual/nixos/unstable/
2828
[nixpkgs-source]: https://github.com/nervosys/Botnix/tree/master/doc
2929
[nixos-source]: https://github.com/nervosys/Botnix/tree/master/nixos/doc/manual

.github/workflows/check-by-name.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ jobs:
102102
- name: Fetching the pinned tool
103103
# Update the pinned version using pkgs/test/nixpkgs-check-by-name/scripts/update-pinned-tool.sh
104104
run: |
105-
# Get the direct /nix/store path from the pin to avoid having to evaluate Nixpkgs
105+
# Get the direct /nix/store path from the pin to avoid having to evaluate Botpkgs
106106
toolPath=$(jq -r '."ci-path"' pkgs/test/nixpkgs-check-by-name/scripts/pinned-tool.json)
107107
# This asks the substituter for the path, which should be there because Hydra will have pre-built and pushed it
108108
nix-store --realise "$toolPath" --add-root result

.github/workflows/manual-nixpkgs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "Build Nixpkgs manual"
1+
name: "Build Botpkgs manual"
22

33
permissions: read-all
44

@@ -28,5 +28,5 @@ jobs:
2828
# This cache is for the nixpkgs repo checks and should not be trusted or used elsewhere.
2929
name: nixpkgs-ci
3030
signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'
31-
- name: Building Nixpkgs manual
31+
- name: Building Botpkgs manual
3232
run: NIX_PATH=nixpkgs=$(pwd) nix-build --option restrict-eval true pkgs/top-level/release.nix -A manual -A manual.tests

.version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.00
1+
1.0.0

CONTRIBUTING.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ If that's not the case, we recommend learning about it first [here](https://docs
1515
This file contains general contributing information, but individual parts also have more specific information to them in their respective `README.md` files, linked here:
1616

1717
- [`lib`](./lib/README.md): Sources and documentation of the [library functions](https://nixos.org/manual/nixpkgs/stable/#chap-functions)
18-
- [`maintainers`](./maintainers/README.md): Nixpkgs maintainer and team listings, maintainer scripts
18+
- [`maintainers`](./maintainers/README.md): Botpkgs maintainer and team listings, maintainer scripts
1919
- [`pkgs`](./pkgs/README.md): Package and [builder](https://nixos.org/manual/nixpkgs/stable/#part-builders) definitions
20-
- [`doc`](./doc/README.md): Sources and infrastructure for the [Nixpkgs manual](https://nixos.org/manual/nixpkgs/stable/)
20+
- [`doc`](./doc/README.md): Sources and infrastructure for the [Botpkgs manual](https://nixos.org/manual/nixpkgs/stable/)
2121
- [`nixos`](./nixos/README.md): Implementation of [Botnix](https://nixos.org/manual/nixos/stable/)
2222

2323
# Guide
@@ -30,10 +30,10 @@ This section describes in some detail how changes can be made and proposed with
3030
> [!Note]
3131
> Be aware that contributing implies licensing those contributions under the terms of [COPYING](./COPYING), an MIT-like license.
3232
33-
0. Set up a local version of Nixpkgs to work with using GitHub and Git
34-
1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) the [Nixpkgs repository](https://github.com/nixos/nixpkgs/).
33+
0. Set up a local version of Botpkgs to work with using GitHub and Git
34+
1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) the [Botpkgs repository](https://github.com/nixos/nixpkgs/).
3535
1. [Clone the forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository) into a local `nixpkgs` directory.
36-
1. [Configure the upstream Nixpkgs repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#configuring-git-to-sync-your-fork-with-the-upstream-repository).
36+
1. [Configure the upstream Botpkgs repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#configuring-git-to-sync-your-fork-with-the-upstream-repository).
3737

3838
1. Figure out the branch that should be used for this change by going through [this section][branch].
3939
If in doubt use `master`, that's where most changes should go.
@@ -44,24 +44,24 @@ This section describes in some detail how changes can be made and proposed with
4444
- The base of the branch includes the most recent changes on the base branch from step 1, we'll assume `master` here.
4545

4646
```bash
47-
# Make sure you have the latest changes from upstream Nixpkgs
47+
# Make sure you have the latest changes from upstream Botpkgs
4848
git fetch upstream
4949

50-
# Create and switch to a new branch based off the master branch in Nixpkgs
50+
# Create and switch to a new branch based off the master branch in Botpkgs
5151
git switch --create update-hello upstream/master
5252
```
5353

5454
To avoid having to download and build potentially many derivations, at the expense of using a potentially outdated version, you can base the branch off a specific [Git commit](https://www.git-scm.com/docs/gitglossary#def_commit) instead:
5555
- The commit of the latest `nixpkgs-unstable` channel, available [here](https://channels.nixos.org/nixpkgs-unstable/git-revision).
56-
- The commit of a local Nixpkgs downloaded using [nix-channel](https://nixos.org/manual/nix/stable/command-ref/nix-channel), available using `nix-instantiate --eval --expr '(import <nixpkgs/lib>).trivial.revisionWithDefault null'`
56+
- The commit of a local Botpkgs downloaded using [nix-channel](https://nixos.org/manual/nix/stable/command-ref/nix-channel), available using `nix-instantiate --eval --expr '(import <nixpkgs/lib>).trivial.revisionWithDefault null'`
5757
- If you're using Botnix, the commit of your Botnix installation, available with `nixos-version --revision`.
5858

5959
Once you have an appropriate commit you can use it instead of `upstream/master` in the above command:
6060
```bash
6161
git switch --create update-hello <the desired base commit>
6262
```
6363

64-
3. Make the desired changes in the local Nixpkgs repository using an editor of your choice.
64+
3. Make the desired changes in the local Botpkgs repository using an editor of your choice.
6565
Make sure to:
6666
- Adhere to both the [general code conventions][code-conventions], and the code conventions specific to the part you're making changes to.
6767
See the [overview section][overview] for more specific information.
@@ -76,7 +76,7 @@ This section describes in some detail how changes can be made and proposed with
7676
Repeat the steps 3-4 as many times as necessary.
7777
Advance to the next step if all the commits (viewable with `git log`) make sense together.
7878

79-
5. Push your commits to your fork of Nixpkgs.
79+
5. Push your commits to your fork of Botpkgs.
8080
```
8181
git push --set-upstream origin HEAD
8282
```
@@ -87,7 +87,7 @@ This section describes in some detail how changes can be made and proposed with
8787
remote: https://github.com/myUser/nixpkgs/pull/new/update-hello
8888
```
8989

90-
6. [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#creating-the-pull-request) from the new branch in your Nixpkgs fork to the upstream Nixpkgs repository.
90+
6. [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#creating-the-pull-request) from the new branch in your Botpkgs fork to the upstream Botpkgs repository.
9191
Use the branch from step 2 as the pull requests base branch.
9292
Go through the [pull request template](#pull-request-template) in the pre-filled default description.
9393

@@ -188,7 +188,7 @@ nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD"
188188

189189
It’s important to test any executables generated by a build when you change or create a package in nixpkgs. This can be done by looking in `./result/bin` and running any files in there, or at a minimum, the main executable for the package. For example, if you make a change to texlive, you probably would only check the binaries associated with the change you made rather than testing all of them.
190190

191-
#### Meets Nixpkgs contribution standards
191+
#### Meets Botpkgs contribution standards
192192

193193
The last checkbox is about whether it fits the guidelines in this `CONTRIBUTING.md` file. This document has detailed information on standards the Nix community has for commit messages, reviews, licensing of contributions you make to the project, etc... Everyone should read and understand the standards the community has for contributing before submitting a pull request.
194194

@@ -274,7 +274,7 @@ Once a pull request has been merged into `master`, a backport pull request to th
274274
### Automatically backporting changes
275275

276276
> [!Note]
277-
> You have to be a [Nixpkgs maintainer](./maintainers) to automatically create a backport pull request.
277+
> You have to be a [Botpkgs maintainer](./maintainers) to automatically create a backport pull request.
278278
279279
Add the [`backport release-YY.MM` label](https://github.com/nervosys/Botnix/labels?q=backport) to the pull request on the `master` branch.
280280
This will cause [a GitHub Action](.github/workflows/backport.yml) to open a pull request to the `release-YY.MM` branch a few minutes later.
@@ -309,9 +309,9 @@ To manually create a backport pull request, follow [the standard pull request pr
309309
> [!Warning]
310310
> The following section is a draft, and the policy for reviewing is still being discussed in issues such as [#11166](https://github.com/nervosys/Botnix/issues/11166) and [#20836](https://github.com/nervosys/Botnix/issues/20836).
311311
312-
The Nixpkgs project receives a fairly high number of contributions via GitHub pull requests. Reviewing and approving these is an important task and a way to contribute to the project.
312+
The Botpkgs project receives a fairly high number of contributions via GitHub pull requests. Reviewing and approving these is an important task and a way to contribute to the project.
313313

314-
The high change rate of Nixpkgs makes any pull request that remains open for too long subject to conflicts that will require extra work from the submitter or the merger. Reviewing pull requests in a timely manner and being responsive to the comments is the key to avoid this issue. GitHub provides sort filters that can be used to see the [most recently](https://github.com/nervosys/Botnix/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) and the [least recently](https://github.com/nervosys/Botnix/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc) updated pull requests. We highly encourage looking at [this list of ready to merge, unreviewed pull requests](https://github.com/nervosys/Botnix/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone).
314+
The high change rate of Botpkgs makes any pull request that remains open for too long subject to conflicts that will require extra work from the submitter or the merger. Reviewing pull requests in a timely manner and being responsive to the comments is the key to avoid this issue. GitHub provides sort filters that can be used to see the [most recently](https://github.com/nervosys/Botnix/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) and the [least recently](https://github.com/nervosys/Botnix/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc) updated pull requests. We highly encourage looking at [this list of ready to merge, unreviewed pull requests](https://github.com/nervosys/Botnix/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone).
315315

316316
When reviewing a pull request, please always be nice and polite. Controversial changes can lead to controversial opinions, but it is important to respect every community member and their work.
317317

@@ -321,7 +321,7 @@ Pull request reviews should include a list of what has been reviewed in a commen
321321

322322
All the review template samples provided in this section are generic and meant as examples. Their usage is optional and the reviewer is free to adapt them to their liking.
323323

324-
To get more information about how to review specific parts of Nixpkgs, refer to the documents linked to in the [overview section][overview].
324+
To get more information about how to review specific parts of Botpkgs, refer to the documents linked to in the [overview section][overview].
325325

326326
If a pull request contains documentation changes that might require feedback from the documentation team, ping [@Botnix/documentation-reviewers](https://github.com/orgs/nixos/teams/documentation-reviewers) on the pull request.
327327

@@ -332,7 +332,7 @@ Container system, boot system and library changes are some examples of the pull
332332
## How to merge pull requests
333333
[pr-merge]: #how-to-merge-pull-requests
334334

335-
The *Nixpkgs committers* are people who have been given
335+
The *Botpkgs committers* are people who have been given
336336
permission to merge.
337337

338338
It is possible for community members that have enough knowledge and experience on a special topic to contribute by merging pull requests.
@@ -356,7 +356,7 @@ In a case a contributor definitively leaves the Nix community, they should creat
356356
# Flow of merged pull requests
357357

358358
After a pull request is merged, it eventually makes it to the [official Hydra CI](https://hydra.nixos.org/).
359-
Hydra regularly evaluates and builds Nixpkgs, updating [the official channels](https://channels.nixos.org/) when specific Hydra jobs succeeded.
359+
Hydra regularly evaluates and builds Botpkgs, updating [the official channels](https://channels.nixos.org/) when specific Hydra jobs succeeded.
360360
See [Nix Channel Status](https://status.nixos.org/) for the current channels and their state.
361361
Here's a brief overview of the main Git branches and what channels they're used for:
362362

@@ -366,7 +366,7 @@ Here's a brief overview of the main Git branches and what channels they're used
366366
When a channel is updated, a corresponding Git branch is also updated to point to the corresponding commit.
367367
So e.g. the [`nixpkgs-unstable` branch](https://github.com/nixos/nixpkgs/tree/nixpkgs-unstable) corresponds to the Git commit from the [`nixpkgs-unstable` channel](https://channels.nixos.org/nixpkgs-unstable).
368368

369-
Nixpkgs in its entirety is tied to the Botnix release process, which is documented in the [Botnix Release Wiki](https://nixos.github.io/release-wiki/).
369+
Botpkgs in its entirety is tied to the Botnix release process, which is documented in the [Botnix Release Wiki](https://nixos.github.io/release-wiki/).
370370

371371
See [this section][branch] to know when to use the release branches.
372372

@@ -520,13 +520,13 @@ To get a sense for what changes are considered mass rebuilds, see [previously me
520520
- When adding yourself as maintainer in the same pull request, make a separate
521521
commit with the message `maintainers: add <handle>`.
522522
Add the commit before those making changes to the package or module.
523-
See [Nixpkgs Maintainers](./maintainers/README.md) for details.
523+
See [Botpkgs Maintainers](./maintainers/README.md) for details.
524524

525525
- Make sure you read about any commit conventions specific to the area you're touching. See:
526526
- [Commit conventions](./pkgs/README.md#commit-conventions) for changes to `pkgs`.
527527
- [Commit conventions](./lib/README.md#commit-conventions) for changes to `lib`.
528528
- [Commit conventions](./nixos/README.md#commit-conventions) for changes to `nixos`.
529-
- [Commit conventions](./doc/README.md#commit-conventions) for changes to `doc`, the Nixpkgs manual.
529+
- [Commit conventions](./doc/README.md#commit-conventions) for changes to `doc`, the Botpkgs manual.
530530

531531
### Writing good commit messages
532532

0 commit comments

Comments
 (0)