Add narrative documentation on how we do binary deployment
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- cpp, nodejs
- Ambito
- build-system, documentation, release
Direzione di ricerca
Inizia da glossary.md e dalle pagine wiki esistenti di node-pre-gyp relative a External-libraries e FAQ. Segui il flusso documentato dal codice sorgente C++ attraverso i node addons fino alla distribuzione dei binari, includendo mason e node-pre-gyp, quindi integra in questo repository la documentazione precedente pertinente con collegamenti al glossario e al materiale correlato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Now that our https://github.com/mapbox/cpp/blob/master/glossary.md is fairly complete, it is a good time to add new, narrative docs that tie together glossary terms.
In particular, there is a need for a binary deployment doc that explains the flow from C++ source code -> node addons -> binary distribution.
Here is a first stab at listing things to cover in this doc:
We use mason for:
- distributing pre-compiled (aka binary) static libraries for C/C++ code. And in rare cases shared libraries.
- distributing source code of header-only libraries
- distributing binaries of executables (aka command line programs).
We use node-pre-gyp for:
- Binary deployment of node C++ addons
- When those node C++ addons have external C/C++ dependencies we use mason to pull packages for them
- Soon we'll open source https://github.com/mapbox/mason-js which will make these more seamless (no need for the mason bash scripts)
TODO:
- integrate old node-pre-gyp docs into this repo and modify them to link to the glossary and this repo where appropriate. E.g. https://github.com/mapbox/node-pre-gyp/wiki/External-libraries, https://github.com/mapbox/node-pre-gyp/wiki/FAQ
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 110
- Fork
- 17
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di mapbox/cpp
-
glossary
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 68/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 25/100
-
Docs on ABIs Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 30/100
-
clang-tidy v. -Weffc++ Aperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 30/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
Issue simili
-
Update to NCCL 2.32 Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
conda-forge/nccl-feedstock#166 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
dsx-ai-factory/infra-controller#6694 ·
-
bug build
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
facebookincubator/velox#19143 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
pydantic/pydantic-ai#8636 ·
-
0.kind: enhancement 9.needs: package (update)
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100