Hvordan jobbe med releasenotes i Utviklerportalen

Dette dokumentet beskriver hvordan du håndterer releasenotes i repoet. Kort oppsummert kan du ha en fil som heter releasenotes.json under docs‑katalogen, og den vil automatisk bli rendret i Utviklerportalen. Merk at du også kan legge den til via backoffice (her).

Hente JSON‑en til eksisterende releasenote

Noen har allerede opprettet releasenotes i Utviklerportal‑CMS. For å lette overgangen er det laget et API‑endpoint som gjør at du kan hente ut JSON‑en. Deretter kan du kopiere den inn i en releasenotes.json‑fil, og du får et mye enklere oppsett 👍

Slik gjør du for å eksportere JSON‑en:

1. Logg inn i backoffice for Utviklerportalen (https://utviklerportal.nhn.no/umbraco)
2. Finn ID‑en til releasenoten. Den ligger på fanen «Info» og består av fire sifre.
3. Bruk API‑endpointet GetReleasenotes for å hente den: (https://utviklerportal.nhn.no/swagger/index.html). Den enkleste måten er å bruke «Try it out»‑funksjonen.

releasenotes.json‑filen

Nedenfor er et eksempel på hvordan denne filen kan se ut:

{
  "headline": "Release Notes - Utviklerportal",
  "introText": null,
  "majorVersions": [
    {
      "title": "Version 5",
      "minorVersions": [
        {
          "title": "5.0 - Umbraco 12",
          "releaseDate": "2023-11-28T00:00:00",
          "status": "prod",
          "description": "Description of the version"
        }
      ]
    },
  ]
}

De fleste feltene er selvforklarende. JSON‑filen kan inneholde flere majorVersions, og hver majorVersion kan ha flere minorVersions.

Hvor skal releasenotes.json‑filen plasseres?

releasenotes.json‑filen må legges direkte i /docs‑katalogen. Dette er foreløpig den eneste støttede plasseringen for filen.