Pomoc pro vývojáře
Čtete neoficiální překlad originální stránky.
Licencování by mělo být pro vývojáře snadné. Poskytujeme několik nástrojů a služeb, které vám umožní soustředit se na kódování.
Obsah: Pomocný nástroj, Příklad repozitářů, REUSE API, CI/CD workflow
Pomocný nástroj
Pomocný nástroj REUSE helper tool pomáhá při dosahování a potvrzování shody s nařízením REUSE. Stahuje úplné licenční texty, přidává do hlaviček souborů informace o autorských právech a licenci a obsahuje liner pro identifikaci problémů. Nakonec lze vygenerovat softwarový kusovník.
Přečtěte si dokumentaci, kde se dozvíte více o nástroji. Najdete zde také sekci nástrojů v našich FAQ pro nejnaléhavější otázky.
Příklad repozitářů
Jak vypadá projekt v souladu s REUSE? Následující úložiště jsou základní, ale každé z nich je v souladu s REUSE. Dáváme je k dispozici, abychom ukázali, jak REUSE funguje v praxi.
- reuse-example - úložiště vyhovující požadavkům REUSE, které ukazuje několik metod přidávání informací o autorských právech a licencích. Obsahuje větev, která není v souladu s předpisy, pro testování. Tento projekt je základem pro náš výukový program. - reuse-tool - samotný pomocný nástroj je kompatibilní, stejně jako všechny ostatní repozitáře REUSE.
Zvažte registraci svého projektu v rozhraní REUSE API, abyste mohli zahrnout dynamický odznak shody.
API
Rozhraní REUSE API vám pomůže průběžně kontrolovat a zobrazovat dodržování pokynů REUSE. Do souboru README můžete zahrnout odznak označující živý stav a výstup analyzovat pomocí vygenerovaného souboru JSON.
Takto bude vypadat odznak pro projekt, který je v souladu se směrnicí REUSE. Kliknutím na odznak se zobrazí další informace:
Rozhraní API je dokonalým nástrojem pro všechny, kteří chtějí prokázat, že jejich úložiště dodržuje osvědčené postupy při poskytování informací o licencích a autorských právech. Umožňuje službám třetích stran integrovat živý stav REUSE a nabízí jednoduchou alternativu pro lidi, kteří nechtějí instalovat pomocný nástroj REUSE helper tool pro první rychlou kontrolu.
Stejně jako vše ostatní v REUSE je API veřejně dostupné pod licencemi svobodného softwaru.
Pre-commit hook
Při každé revizi můžete automaticky spustit reuse lint
jako hook před
revizí pro systém Git. Používá se
pre-commit. Jakmile jej
nainstalujete, přidejte jej do souboru
.pre-commit-config.yaml
ve svém úložišti:
repos:
- repo: https://github.com/fsfe/reuse-tool
rev: v1.0.0
hooks:
- id: reuse
Poté spusťte pre-commit install
. Nyní se při každé revizi na pozadí spustí
reuse lint
, který zabrání revizi, pokud se vyskytne chyba.
Zařazení do pracovních postupů CI/CD
REUSE lze snadno integrovat do stávajících procesů CI/CD a průběžně testovat úložiště a jeho změny na shodu s REUSE.
FSFE nabízí obraz Docker, který lze použít v mnoha řešeních CI. Níže najdete několik příkladů:
Drone
Do souboru .drone.yml
vložte následující úryvek:
steps:
- name: reuse
image: fsfe/reuse:latest
Více informací o Drone na drone.io.
GitHub
Uživatelé GitHub mohou akci REUSE začlenit do svých pracovních postupů. Pokyny k použití naleznete na stránce stránka akce na marketplace.
Další informace o akcích GitHub najdete na help.github.com.
GitLab
Do souboru .gitlab-ci.yml
vložte následující úryvek:
reuse:
image:
name: fsfe/reuse:latest
entrypoint: [""]
script:
- reuse lint
Další informace o CI GitLabu najdete na docs.gitlab.com.
Travis CI
Do souboru .travis.yml
vložte následující úryvek:
language: minimal
services:
- docker
before_install:
- docker pull fsfe/reuse:latest
- docker run -v ${TRAVIS_BUILD_DIR}:/data fsfe/reuse:latest lint
Více informací o Travis CI najdete na travis-ci.com.