Fara í efni

Útgáfa

Sérfræðingur

Breyttu prófaðri smíði í útgáfu. Þessi síða er fyrir umsjónarmenn.

  • Allar athuganir í Prófanir ganga í gegn, þar á meðal full end-to-end keyrsla og löngu keyrslurnar og fault-keyrslurnar.
  • CHANGELOG.md hefur nýju útgáfuna.
  • Python 3 er uppsett fyrir útgáfuskriftirnar.
  1. Skrifaðu releases/notes-<version>.toml, til dæmis releases/notes-1.0.0.toml. Sjá Skrá með útgáfuskýringum.

  2. Athugaðu hana:

    Terminal window
    python deploy/release/notes.py 1.0.0 --check

    Þú ættir ekki að sjá neinar villur. Bannað orð, em-strik, dagsetning, tal um opnun eða endurtekin lykilatriði gefa útkomuna 1.

  3. Búðu til útgáfutextana:

    Terminal window
    python deploy/release/notes.py 1.0.0

    Þú ættir að finna 7 skrár í releases/out/1.0.0/.

  4. Smíðaðu image og ræstu það á nýrri stillingamöppu:

    Terminal window
    docker build --file deploy/Dockerfile .

    Þú ættir að sjá töframann fyrstu ræsingar.

  5. Keyrðu allar athuganir í Prófanir á þinni tölvu. Próf keyra staðbundið, ekki á GitHub.

  6. Réttu umsjónarmanninum útgáfuna. Umsjónarmaðurinn ýtir útgáfumerkinu á main, og það ræsir útgáfuna.

Nöfn á útgáfum og merkjum

Tengill á Nöfn á útgáfum og merkjum
Hlutur Nafn
Git-merki (ýtt af umsjónarmanni) 1.0.0 (venjuleg númer, ekkert v)
Image tag og version í skýringunum 1.0.0

Workflow ræsist aðeins fyrir X.Y.Z merki og stöðvast þegar merkið er ekki eins og VERSION skráin.

Hver útgáfa ýtir útgáfumerki sínu og :latest.

Taktu útgáfu til baka

Tengill á Taktu útgáfu til baka
  1. Ýttu næstu útgáfu með lagfærslunni.
  2. Merktu slæmu útgáfuna í uppfærslulistanum svo uppsetningar bjóði hana ekki.
  3. Haltu merkinu.

Einkenni. notes.py --check skilar 1. Orsök. Skýringaskráin brýtur reglu. Skilaboðin nefna línuna. Lausn. Breyttu skýringaskránni, aldrei skránum í releases/out, og keyrðu aftur.

Einkenni. Workflow stöðvast með VERSION says. Orsök. Merkið og VERSION skráin eru ekki eins. Lausn. Lagaðu VERSION á main og ýttu næsta útgáfumerki.

Skrá með útgáfuskýringum

Allir útgáfutextar koma úr einni skrá. Breyttu aldrei með hendi því sem hún býr til.

Reitur Innihald
version Venjulegt X.Y.Z
theme Ein lína
images Listi af {registry, name}. Aðeins Docker Hub holyarrs/holyarrs
docs_url Valfrjálst. Tómt þýðir enginn tengill á Docs
[[highlights]] Nákvæmlega 3, hvert með line, issues og shot. Issues þeirra birtast í engri hópalínu
[groups] Línur fyrir hvern stað. New er sjálfgefið. Aðrar byrja á Changed: , Fixed: eða Docs: . Hver endar á sínu issue, eins og (#46). Staður með færri en 3 línur fer undir Also new
Valfrjálst [before_you_update] (breaking, manual_steps, backup, rollback), security, known_issues, credits, [stats]. Tómir hlutar eru faldir

Notaðu GitHub-notandanafn aðeins þegar það er þekkt, í skýringaskránni eða í releases/credits-map.json.

Röð í meginmáli: theme, Highlights, staðir (Requests, Library, Downloads, Indexers, Accounts, Health, Setup, Install), Also new, Security, Known issues, Before you update, Image, Thanks, tölfræðilína.

Úttak í releases/out/<version>/ Notað fyrir
changelog.md Færsluna í changelog
github.md Meginmál GitHub-útgáfunnar
update-notes.json Skýringarnar sem forritið sýnir
reddit.txt Reddit-færsluna
discord-dm.txt, discord-announce.md Discord. Hvort um sig er undir 1.000 stöfum
roadmap-card.json Vegvísaspjaldið

notes.py tekur --file (aðra skýringaskrá), --map (annað credits-kort), --out (aðra úttaksmöppu) og --date. --check varar við löngum línum og næstum endurtekningum.

Image workflow

Workflow HolyArrs - Release ræsist þegar útgáfumerki er ýtt. Það hefur þrjú skref:

  1. Smíða og ýta image fyrir linux/amd64, linux/arm64 og linux/arm/v7, með útgáfutaginu og latest.
  2. Uppfæra lýsinguna á Docker Hub úr README.md.
  3. Birta GitHub-útgáfuna með kaflanum úr CHANGELOG.md fyrir þessa útgáfu.
Uppfærslulisti

Forritið les undirritaðan uppfærslulista. Hver útgáfa bætir við sinni færslu og undirritar hann. Undirritunarlykillinn fer aldrei í repo. HolyArrs hafnar lista sem það getur ekki staðfest.

Eftir útgáfu skaltu athuga að útgáfumerkið á image passi við tagið, og fylgjast með nýjum issues fyrsta daginn:

Terminal window
docker inspect --format '{{ index .Config.Labels "org.opencontainers.image.version" }}' holyarrs
Unraid prófunarsniðmát

deploy/release/nas-template.py skrifar Unraid-notendasniðmát fyrir eitt nákvæmt image. Það sækir, setur upp og birtir ekkert.

Terminal window
python deploy/release/nas-template.py --image 'holyarrs/holyarrs@sha256:<digest>' --config '/mnt/<pool>/appdata/holyarrs-test' --movies /mnt/user/holyarrs-test-data/movies --downloads /mnt/user/holyarrs-test-data/downloads --port 6262 --output holyarrs-test.xml

Skiptu út <digest> og <pool>.

Flagg Athugið
--image Manifest digest í registry, ekki Docker image ID
--config Slóð á pool. Tólið hafnar /mnt/user og /mnt/user0
--movies, --tv, --music, --downloads Valfrjálst. Aðskildar slóðir eru aðskildar tengingar, svo innflutningur afritar
--port Sjálfgefið 6262
--allowed-hosts Valfrjálst, host-nöfn aðskilin með kommum
--output XML-skráin sem er skrifuð

Sniðmátið stillir PUID=99, PGID=100 og UMASK=022. Gefðu þeim reikningi skrifaðgang að prófunarmiðlunum. Settu skrána í /boot/config/plugins/dockerMan/templates-user/ og veldu hana undir Docker > Add Container > Template (Docker > bæta við container > sniðmát).

HolyArrs er ókeypis. Ef það sparaði þér tíma geturðu gefið því stjörnu á GitHub, styrkt það eða boðið mér í kaffi.