[Documentation] Update actions documentation to note that secondary checkouts will wipe the first checkout

Open
#978 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions

Research direction

Start with the multi-repo checkout documentation referenced in the issue and review the existing checkout examples. Update it to explain that checkout order matters and that a later checkout without a path can wipe the earlier workspace, including running services. Done means the warning and safe ordering are clear in the documentation examples.

Written by the indexing model from the issue text.

Description

I spent a considerable amount of hours trying to track down a networking bug which turned out to be just an oddity with the current github actions/checkout multi-repo documentation.

This preserves both environments: the parent project which sources the GHA and the secondary repo

      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: "16"
     - uses: actions/checkout@v3
        with:
          repository: unlikelyzero/quickstart
          ref: fix-network
          path: 'quickstart'

This will wipe the first at the instance that actions/checkout is run -- including any running services in that workspace.

      - uses: actions/checkout@v3
        with:
          repository: unlikelyzero/quickstart
          ref: fix-network
          path: 'quickstart'
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: "16"

I think the multi-repo readme should be updated with language to prevent headaches and heartburn.

Dominant language
TypeScript
Stars
8.9k
Forks
2.8k
PR merge metrics
No merged PRs in 30d

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.

More from actions/checkout

All issues in actions/checkout

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.