Verificări și teste pentru pull request

Atunci când ridici un pull request (PR) cu repertoriul opentelemetry.io sunt set de verificări sunt executate. Aceste verificări de PR se asigură că:

• Ai semnat CLA-ul
• PR-ul tău se lansează prin Netlify
• Modificările tale sunt conforme cu ghidul de stil

Easy CLA

Această verificare eșuează dacă nu ai semnat CLA-ul.

Deployment Netlify {netlify-deployment}

Dacă build-ul de Netlify eșuează, selectează Detalii pentru mai multe informații.

Verificările de GitHub PR

Pentru a ne asigura că schimbările urmăresc ghidul de stil am implementat un set de verificări care validează regulile ghidului de stil și eșuează dacă găsesc vreo problemă.

Secțiunile de mai jos descriu verificările actuale și ce poți face pentru a remedia erorile aferente.

TEXT linter

Această verificare validează faptul că Termeni și cuvinte specifice OpenTelemetry sunt utilizate în mod constant pe tot site-ul.

Dacă se constată probleme, se adaugă adnotări în fișierele tale din secțiunea files changed a PR-ului tău. Corectează-le pentru a trece verificările. Ca o alternativă, poți rula local npm run check:text -- --fix pentru a rezolva majoritate problemelor. Rulează npm run check:text din nou și rezolvă manual problemele rămase.

MARKDOWN linter

Această verificare validează dacă standardele și consecvența pentru fișierele Markdown sunt aplicate.

Dacă se constată probleme, rulează npm run fix:markdown pentru a rezolva majoritate problemelor automat. Pentru orice problemă rămasă, rulează npm run check:markdown și aplică modificările sugerate manual.

SPELLING check

Această verificare validează dacă toate cuvintele sunt scrise corect în toate localizările.

Dacă această verificare eșuează, rulează npm run check:spelling local pentru a vedea problemele. Pentru a adăuga sau schimba cuvintele permise, vezi verificare ortografică în ghidul de stil.

CSPELL check

Această verificare validează dacă listele cSpell:ignore din front matter sunt normalizate și dacă listele de cuvinte .cspell/*.txt sunt sortate (vezi npm run fix:dict).

Dacă această verificare eșuează, rulează npm run fix:dict local și introdu modificările într-un nou commit.

FILE FORMAT

Această verificare validează dacă toate fișierele sunt conforme cu Regulile de formatare Prettier.

Dacă această verificare eșuează, rulează npm run fix:format local și introdu modificările într-un nou commit.

FILENAME check

Această verificare validează dacă:

• Toate numele de fișiere sunt kebab-case
• Nu există fișiere sau foldere învechite în repertoriu (vezi lista de mai jos)

Dacă această verificare eșuează, rulează npm run fix:filenames local și introdu modificările într-un nou commit.

Fișiere și foldere învechite {obsolete-files-and-folders}

Următoarele căi sunt semnalate ca fiind vechi și sunt înlăturare de fix:filenames. Când există, un issue sau număr de PR oferă context pentru schimbarea care a făcut acea cale să fie învechită.

• tools/ - Migrate code-excerpts tooling to npm package version #9638

BUILD and CHECK LINKS

Aceste două verificări construiesc website-ul și verifică că toate link-urile sunt valide.

Pentru a construi și verifica link-uri local, rulează npm run check:links. Această comandă de asemenea actualizează și cache-ul de referință. Adaugă orice modificare la refcache într-un nou comit.

Rezolvă erorile 404

Trebuie să repari URL-urile semnalate ca și invalide (HTTP status 404), de către verificarea de link-uri.

Gestionarea linkurilor externe valide

Verificarea link-urilor va primi uneori alte status-uri HTTP decât 200 (succes) de la servere care blochează verificatoarele. Asemenea servere vor întoarce des un status HTTP în intervalul 400 altele decât 404, precum 401, 403 sau 406, care sunt cele mai comune. Unele servere, link LinkedIn, întorc 999.

Dacă ai validat manual un link extern pentru care verificatorul nu primește un status de succes, poți adăuga următorul parametru de interogare în URL-ul tău pentru a ajuta verificatorul de link-uri să-l ignore: ?link-check=no sau &link-check=no dacă sunt și alți parametrii de interogare. De exemplu, următoarele URL-uri vor fi ignorate:

• https:/some-example.org?link-check=no
• https:/some-example.org?other-param=value&link-check=no

./scripts/double-check-refcache-4XX.mjs

WARNINGS in build log?

Dacă această verificare eșuează, revizuiește log-ul de BUILD and CHECK LINKS, sub pasul npm run log:check:links, pentru alte potențiale probleme. Solicită sprijin de la întreținători, dacă nu știi cum să rezolvi această problemă.

Mereu folosește o cale pentru link-uri site-local

Atunci când facem link-uri către pagini din website-ul OpenTelemetry, folosește căi locale în loc de link-uri externe. Build-ul va emite un avertisment dacă nu faci asta.

Pentru a remedia avertismentul de build, păstrează doar partea cu calea din adresa URL completă:

Utilizarea căilor locale asigură că:

• Paginile site-local se deschid în același tab de browser: Link-urile externe se deschid într-un tab nou, comportament care nu este apreciat în navigarea site-local.
• Procesarea link-urilor de localizare funcționează conform așteptărilor: link-urile sunt prefixate automat cu codul de limbă aferent.
• Căile locale sunt mai ușor de verificat și încarcă refcache-ul inutil.

LOCALIZATION guidelines

Această verificare impune verificarea mecanică a ghidului de localizare, precum a nu copia imagini și alte asset-uri în alte localizări, care nu sunt deja acoperite de alte verificări

Dacă această verificare eșuează, rulează npm run fix:l10n local și adaugă modificările într-un nou commit.

TEST (excluding test:base)

Rulează npm run test:compound-tests, care execută script-uri NPM compuse test:*-* (spre exemplu, teste Netlify edge-function). Această comandă nu rulează test:base.