GitHub Pages

English | 中文 | 日本語 | 한국어 | Français | Deutsch | Español | Português | Svenska | Suomi | Nederlands

Tama repository julkaisee oppaan mdBookilla ja GitHub Pagesilla.

Jokainen kieliopas on itsenainen mdBook-projekti. Jokaisella kielella on oma SUMMARY.md, joten vasen sivupalkki sisaltaa vain nykyisen kielen sivut:

manual/
  en/
    book.toml
    SUMMARY.md
    introduction.md
    quick-start.md
    ...
  zh/
    book.toml
    SUMMARY.md
    introduction.md
    quick-start.md
    ...
  ja/
    book.toml
    SUMMARY.md
    introduction.md
    quick-start.md
    ...
  ko/
  fr/
  de/
  es/
  pt/
  sv/
  fi/
  nl/

Rakenna paikallisesti:

scripts/publish-pages.sh

Luotu sivusto kirjoitetaan hakemistoon:

target/mdbook

Julkaisun tyonkulku

.github/workflows/pages.yml-tyonkulku ajetaan pusheissa main-haaraan ja kasin kaynnistettyna. Se:

1. Checkouttaa repositorion.
2. Asentaa mdBookin.
3. Ajaa scripts/publish-pages.sh.
4. Lataa target/mdbook-hakemiston Pages-artefaktiksi.
5. Julkaisee artefaktin GitHub Pagesiin.

Julkaistu URL on:

https://developerworks.github.io/rust-config-tree/

Crate-julkaisu

Koko commit-, push-, Pages-julkaisu- ja crate-julkaisuvirralle:

scripts/release.sh --execute --message "Release 0.1.3"

Kayta crate-julkaisun apuria repositorion juuresta:

scripts/publish-crate.sh

Oletustila ajaa tarkistukset ja cargo publish --dry-run -komennon. Julkaise crates.io:hon tarkistusten onnistuttua. Jos nykyinen versio on jo olemassa crates.io:ssa, skripti kasvattaa patch-version automaattisesti:

scripts/publish-crate.sh --execute

Skriptin kaytto on tiivistetty tiedostossa scripts/README.md.