actions / actions/toolkit

glob actions need better documentation

Open
#685 3 comments 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
TypeScript
Stars
5.9k
Forks
1.8k
PR merge metrics
No merged PRs in 30d

Description

Glob actions are referenced for pattern matching throughout the actions (like https://github.com/marketplace/actions/upload-a-build-artifact) but the docs don't explain how the pattern engine works. There's no guidance on how it should work and even the tests are underwhelming in providing documentation on how it should work.

If this is using ANY regex engine or other engine leveraged from nodejs or other thing, please SAY SO and point to the docs of that engine. If those docs don't exist one needs to be written. Right now, it's really hard to understand how pattern matching should work, and this is a very useful feature, specially in workflows that uses multiple OSes and environments in their strategy/matrix.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the packages/glob entry point and read packages/glob/tests/internal-pattern.test.ts to determine how pattern matching currently works. Document the engine or Node.js facility used, explain its behavior for cross-platform workflows, link to authoritative engine documentation, and ensure the tests and documentation describe the same behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, tooling
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.