Skip to content

[contributor-docs] Add guide to creating a GitHub action or workflow #26

Open

Description

@xinnanyemm

This document should cover best practices that are important to follow in GitHub Actions, such as:

  • Providing useful output
  • Using secrets for private information (although this could be covered in “Security best practices”)
  • Testing GitHub Actions
  • Using Shell script vs. JavaScript

Activity

  1. changed the title [-]Standards: CI configuration/practices[/-] [+][contributor-docs] Add guide to creating a GitHub action or workflow[/+] on May 19, 2026
  2. exalate-issue-sync commented on May 19, 2026

    @exalate-issue-sync

    Elliot Winkler commented: I think it still makes sense to write a guide. Writing GitHub actions or workflows can be very challenging, and there are a lot of footguns that can easily be missed.

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions