Unverified Commit a4d9bba4 authored by Ellie Hermaszewska's avatar Ellie Hermaszewska
Browse files

Merge remote-tracking branch 'origin/master' into haskell-updates

parents 45c94650 12aa304e
Loading
Loading
Loading
Loading
+0 −1
Original line number Diff line number Diff line
@@ -26,7 +26,6 @@ For new packages please briefly describe the package or provide a link to its ho
  - [ ] (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
  - [ ] (Release notes changes) Ran `nixos/doc/manual/md-to-db.sh` to update generated release notes
- [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).

<!--
+0 −34
Original line number Diff line number Diff line
name: NixOS manual checks

permissions: read-all

on:
  pull_request_target:
    branches-ignore:
      - 'release-**'
    paths:
      - 'nixos/**/*.xml'
      - 'nixos/**/*.md'

jobs:
  tests:
    runs-on: ubuntu-latest
    if: github.repository_owner == 'NixOS'
    steps:
    - uses: actions/checkout@v3
      with:
        # pull_request_target checks out the base branch by default
        ref: refs/pull/${{ github.event.pull_request.number }}/merge
    - uses: cachix/install-nix-action@v18
    - name: Check DocBook files generated from Markdown are consistent
      run: |
        nixos/doc/manual/md-to-db.sh
        git diff --exit-code || {
          echo
          echo 'Generated manual files are out of date.'
          echo 'Please run'
          echo
          echo '    nixos/doc/manual/md-to-db.sh'
          echo
          exit 1
        }
+6 −3
Original line number Diff line number Diff line
@@ -128,14 +128,17 @@ Anything that does not cause user or downstream dependency regressions can be ba
- Security critical applications (E.g. `firefox`)

## Generating 23.05 Release Notes
<!--
note: title unchanged even though we don't need regeneration because extant
PRs will link here. definitely change the title for 23.11 though.
-->

Documentation in nixpkgs is transitioning to a markdown-centric workflow. Release notes now require a translation step to convert from markdown to a compatible docbook document.
Documentation in nixpkgs is transitioning to a markdown-centric workflow. In the past release notes required a translation step to convert from markdown to a compatible docbook document, but this is no longer necessary.

Steps for updating 23.05 Release notes:

1. Edit `nixos/doc/manual/release-notes/rl-2305.section.md` with the desired changes
2. Run `./nixos/doc/manual/md-to-db.sh` to render `nixos/doc/manual/from_md/release-notes/rl-2305.section.xml`
3. Include changes to `rl-2305.section.md` and `rl-2305.section.xml` in the same commit.
2. Commit changes to `rl-2305.section.md`.

## Reviewing contributions

+1 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ MD_TARGETS=$(addsuffix .xml, $(basename $(shell find . -type f -regex '.*\.md$$'
PANDOC ?= pandoc

pandoc_media_dir = media
# NOTE: Keep in sync with NixOS manual (/nixos/doc/manual/md-to-db.sh) and conversion script (/maintainers/scripts/db-to-md.sh).
# NOTE: Keep in sync with conversion script (/maintainers/scripts/db-to-md.sh).
# TODO: Remove raw-attribute when we can get rid of DocBook altogether.
pandoc_commonmark_enabled_extensions = +attributes+fenced_divs+footnotes+bracketed_spans+definition_lists+pipe_tables+raw_attribute
# Not needed:
+0 −11
Original line number Diff line number Diff line
--[[
Converts some HTML elements commonly used in Markdown to corresponding DocBook elements.
]]

function RawInline(elem)
  if elem.format == 'html' and elem.text == '<kbd>' then
    return pandoc.RawInline('docbook', '<keycap>')
  elseif elem.format == 'html' and elem.text == '</kbd>' then
    return pandoc.RawInline('docbook', '</keycap>')
  end
end
Loading