Skip to content

11 - Document external repository adoption #11

Description

@kdelfour

Objectif

Completer la documentation pour l'utilisation dans des depots externes.

Contexte

L'action est maintenant taggee, mais les utilisateurs doivent savoir comment l'installer, ou mettre le secret, quel tag utiliser et comment diagnostiquer un echec.

Scope

  • Ajouter une section installation externe avec @v0.1.0 puis @v1 quand disponible.
  • Ajouter exemples CI failure, release, PR, push et custom.
  • Ajouter documentation des secrets repository vs organization.
  • Ajouter troubleshooting base sur les erreurs observees dans GitHub Actions.
  • Ajouter une section versioning et politique de tags.

Criteres d'acceptation

  • Un nouveau repo peut copier-coller un exemple fonctionnel.
  • Les inputs et event types sont a jour.
  • La doc explique clairement que chaque repo doit fournir STOAT_WEBHOOK_URL.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:docsREADME, examples, and contributor docspriority:p0Must be done before the next releasetype:docsDocumentation change

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions