https://github.com/1024pix/npm-package
Template de repo pour générer un package npm utilisable dans des projets Node.js, en bénéficiant de l'outillage Pix
https://github.com/1024pix/npm-package
Last synced: about 2 months ago
JSON representation
Template de repo pour générer un package npm utilisable dans des projets Node.js, en bénéficiant de l'outillage Pix
- Host: GitHub
- URL: https://github.com/1024pix/npm-package
- Owner: 1024pix
- License: agpl-3.0
- Created: 2024-05-06T11:38:22.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-02-17T00:47:43.000Z (2 months ago)
- Last Synced: 2025-02-17T01:27:46.033Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 11
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# npm-package
Template de repo pour générer un package npm utilisable dans des projets Node.js, en bénéficiant de l'outillage Pix.
## Fonctionnalités
- Auto-release npm et changelogs auto
- Tests auto (natif Node.js)
- Auto-merge
- Renovate
## Usage
Sur GitHub, il faut cliquer sur le bouton "Use this template" puis "Create a new repository".
Choisir un nom de projet, `pix` n'y est pas nécessaire.
### Configuration
Avant tout, il faut configurer ce nouveau repo GitHub. La suite des opérations se passent dans l'onglet "Settings" de GitHub.
#### Accès
Les équipes suivantes doivent avoir accès au projet ("Collaborators and teams") :
- `admin` : Rôle Admin
- `admin-bots` : Rôle Admin
- `dev` : Rôle Admin
- `merge-bots` : Rôle Write
#### Secrets
Ces secrets GitHub ("Secrets and variables" > "Actions" > "Repository secrets") sont nécessaires :
- `PIX_SERVICE_ACTIONS_TOKEN`, à récupérer dans le gestionnaire de mots de passe.
- `NPM_PUBLISH_ACCESS_TOKEN`, à configurer sur https://www.npmjs.com/ avec le compte dédié.
L'équipe Captains pourra vous aider si vous ne savez pas comment les configurer.
### Initialisation
Cloner votre projet localement et rechercher/remplacer toutes les références à `npm-package` en votre nom de projet.
Mettre à jour le README.md, voici un template qui peut servir :
Exemple de README.md
```markdown
# @1024pix/npm-package
[](https://npmjs.com/package/@1024pix/npm-package)
## Installation
`$ npm install --save @1024pix/npm-package`
## Développement
### Tests auto
`$ npm run test`
```
Pour déclencher une première release, il faut merger [une PR au format habituel](https://github.com/1024pix/pix/blob/dev/CONTRIBUTING.md#format).