> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Protéger l'action GitHub

> Enregistrez les empreintes de fichiers privés à partir des workflows GitHub et vérifiez les octets d'artefacts originaux.

L'action Protect hache les fichiers sélectionnés localement et crée une empreinte signée
enregistrements à l'aide d'un compte consommateur. Le contenu du fichier n'est pas téléchargé. La signature
lie une empreinte digitale à un enregistrement ; il n'établit pas la paternité, la propriété des droits d'auteur,
ou si une description est vraie.

## Avant de commencer

Utilisez un jeton consommateur autorisé de votre compte Truthlocks Verify. Un
la clé API d'entreprise n'est pas interchangeable avec ce jeton. Stockez le jeton dans un
Secret du dépôt GitHub nommé `TRUTHLOCK_TOKEN`. Ne l'exposez pas à des tiers non fiables
demandes de tirage ou l'imprimer dans les journaux.

L'action installe l'interface de ligne de commande `@truthlocks/protect@1.1.1` épinglée avec Node.js 22.
Commencez par un workflow déclenché manuellement et un artefact de test étiqueté.

## Démarrage rapide

```yaml theme={null}
# .github/workflows/protect.yml
name: Protect an artifact
on:
  workflow_dispatch:
permissions:
  contents: read
jobs:
  protect:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: truthlocks/truthlock/packages/protect-action@e9609a43a494f785984cac708cc123db17ff0310
        id: protect
        with:
          token: ${{ secrets.TRUTHLOCK_TOKEN }}
          files: '["artifacts/report.pdf"]'
          category: research
          visibility: private
          title-prefix: 'Release artifact - '
      - name: Report created record count
        env:
          RECORD_COUNT: ${{ steps.protect.outputs.protection-count }}
        run: echo "Created $RECORD_COUNT record(s)"
```

Remplacez `artifacts/report.pdf` par un fichier existant dans votre référentiel extrait.
Pour les flux de travail de publication, créez l'artefact avant d'exécuter cette action. Épinglez un élément révisé
SHA de commit complet pour les flux de travail de production.

## Entrées

| Entrée | Requis | Par défaut | Signification |
| - | - | - | - |
| `token` | Oui | — | Jeton de porteur de consommateur autorisé. |
| `files` | Un des fichiers/répertoire | — | Motifs séparés par des espaces, ou un tableau JSON pour les chemins contenant des espaces. |
| `directory` | Un des fichiers/répertoire | — | Sélectionne récursivement les fichiers dans l'espace de travail. |
| `category` | Non | `code` | Classification du contenu. |
| `visibility` | Non | `private` | `private` ou explicitement `public`. |
| `algorithm` | Non | `managed` | La signature du consommateur est gérée ; les autres valeurs sont rejetées. |
| `title-prefix` | Non | Vide | Texte ajouté au début du titre de chaque fichier. |

Les catégories prises en charge sont `code`, `research`, `design`, `media`, `dataset`,
`ai-output`, `writing`, `digital-art`, et `other`. La sélection de répertoire exclut
`.git`, `node_modules`, et les liens symboliques. Les entrées doivent rester à l'intérieur de l'espace de travail.
Les motifs non concordants et une sélection vide échouent.

## Sorties et vérification

| Sortie | Signification |
| - | - |
| `attestation-ids` | ID séparés par des virgules pour les enregistrements créés. |
| `protection-count` | Nombre de fichiers traités avec succès. |
| `badge-url` | URL du badge d'enregistrement public ; vide pour les enregistrements privés. |

L'émission d'un enregistrement ne vérifie pas en soi sa signature. Avec le même fichier original,
utilisez la CLI pour vérifier un enregistrement consommateur actuel :

```sh theme={null}
npx --yes --package @truthlocks/protect@1.1.1 truthlock-protect verify YOUR_ATTESTATION_UUID --personal-record --file ./artifacts/report.pdf --json
```

Remplacez l'ID et le chemin du fichier. La CLI reconstruit le personal-record-v2 défini
charge utile signée à partir du hachage du fichier. Il se termine avec succès uniquement lorsque le vérificateur
renvoie `VALID` avec `signature_verified: true`. Les octets modifiés échouent à la vérification.
Une requête par ID seul est `INCOMPLETE` ; elle ne peut pas établir une signature valide.

Les enregistrements privés sont exclus du portefeuille public des consommateurs et n'ont pas
pages de certificat/badge public. Ne publiez pas leurs ID ou ne supposez pas la visibilité
le drapeau masque toutes les métadonnées de vérification à quelqu'un qui connaît déjà un ID.

## Échecs partiels et nouvelles tentatives

Chaque fichier crée un enregistrement distant distinct. L'action s'arrête au premier échec
Appel CLI ; des enregistrements antérieurs peuvent déjà exister. Inspectez ces résultats avant de relancer
un lot, car une répétition peut créer des enregistrements supplémentaires. Il n'y a pas de tout ou rien
transaction par lot ou nouvelle tentative de mutation automatique.

## Lié

* [Protect CLI : reçus enregistrés et vérification de l'espace de travail](https://docs.truthlocks.com/fr/guides/protect-cli.md)
* [Protection du contenu](https://docs.truthlocks.com/fr/guides/content-protection.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.