Skip to content

ci: add a check workflow on documentation#396914

Closed
drupol wants to merge 8 commits intoNixOS:masterfrom
drupol:push-opwrtqunttrv
Closed

ci: add a check workflow on documentation#396914
drupol wants to merge 8 commits intoNixOS:masterfrom
drupol:push-opwrtqunttrv

Conversation

@drupol
Copy link
Contributor

@drupol drupol commented Apr 7, 2025

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@github-actions github-actions bot added 6.topic: python Python is a high-level, general-purpose programming language. 6.topic: GNOME GNOME desktop environment and its underlying platform 6.topic: haskell General-purpose, statically typed, purely functional programming language 6.topic: ruby A dynamic, open source programming language with a focus on simplicity and productivity. 6.topic: vim Advanced text editor 6.topic: erlang General-purpose, concurrent, functional high-level programming language 6.topic: ocaml OCaml is a general-purpose, high-level, multi-paradigm programming language. 6.topic: nodejs Node.js is a free, open-source, cross-platform JavaScript runtime environment 6.topic: TeX Issues regarding texlive and TeX in general 6.topic: agda A dependently typed programming language / interactive theorem prover 6.topic: java Including JDK, tooling, other languages, other VMs 6.topic: nim Nim programing language 6.topic: zig Zig is an imperative, general-purpose, statically typed, compiled system programming language. 6.topic: julia Julia is a high-level, high-performance dynamic language for technical computing. 6.topic: dotnet Language: .NET 6.topic: continuous integration Affects continuous integration (CI) in Nixpkgs, including Ofborg and GitHub Actions 8.has: documentation This PR adds or changes documentation 6.topic: policy discussion Discuss policies to work in and around Nixpkgs backport release-24.11 10.rebuild-darwin: 1 This PR causes 1 package to rebuild on Darwin. 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. labels Apr 7, 2025
@drupol drupol force-pushed the push-opwrtqunttrv branch 2 times, most recently from b493b5b to ad3e6f0 Compare April 7, 2025 21:05
@drupol drupol mentioned this pull request Apr 8, 2025
Merged
13 tasks
@drupol drupol force-pushed the push-opwrtqunttrv branch from ad3e6f0 to 29f55f1 Compare April 8, 2025 09:35
@drupol drupol force-pushed the push-opwrtqunttrv branch from 29f55f1 to 8eab5d2 Compare April 8, 2025 10:35
@wegank wegank added the 2.status: merge conflict This PR has merge conflicts with the target branch label Apr 17, 2025
@drupol drupol mentioned this pull request Apr 21, 2025
Closed
13 tasks
@wolfgangwalther
Copy link
Contributor

wolfgangwalther commented May 11, 2025

Recently, I moved editorconfig-checker and keep-sorted into the treefmt we already have. See #405684.

The idea is to run all formatters through a single interface - treefmt. Thus, new formatters like in this PR should not be added in new workflows, but as part of the treefmt configuration instead. This will make it possible to run them locally as well.

It would be important, though, to have fast formatters. prettier is not really fast. At work I used yamlfmt instead of prettier to format yaml files, which is a lot faster.

biome, the faster alternative to prettier doesn't seem to support markdown, though. So not sure about that part.

@wolfgangwalther
Copy link
Contributor

wolfgangwalther commented Jun 12, 2025

In #416115, I added yamlfmt to ci/treefmt.

Since the prettier stuff for the docs is in a different PR as well, I think this can be closed. Please re-open if that's wrong.

@drupol
Copy link
Contributor Author

drupol commented Jun 12, 2025

Totally fine, thank you for doing it!

@drupol drupol deleted the push-opwrtqunttrv branch June 12, 2025 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

2.status: merge conflict This PR has merge conflicts with the target branch 6.topic: agda A dependently typed programming language / interactive theorem prover 6.topic: continuous integration Affects continuous integration (CI) in Nixpkgs, including Ofborg and GitHub Actions 6.topic: dotnet Language: .NET 6.topic: erlang General-purpose, concurrent, functional high-level programming language 6.topic: GNOME GNOME desktop environment and its underlying platform 6.topic: haskell General-purpose, statically typed, purely functional programming language 6.topic: java Including JDK, tooling, other languages, other VMs 6.topic: julia Julia is a high-level, high-performance dynamic language for technical computing. 6.topic: nim Nim programing language 6.topic: nodejs Node.js is a free, open-source, cross-platform JavaScript runtime environment 6.topic: ocaml OCaml is a general-purpose, high-level, multi-paradigm programming language. 6.topic: policy discussion Discuss policies to work in and around Nixpkgs 6.topic: python Python is a high-level, general-purpose programming language. 6.topic: ruby A dynamic, open source programming language with a focus on simplicity and productivity. 6.topic: TeX Issues regarding texlive and TeX in general 6.topic: vim Advanced text editor 6.topic: zig Zig is an imperative, general-purpose, statically typed, compiled system programming language. 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-darwin: 1 This PR causes 1 package to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@drupol @wolfgangwalther @wegank