[Documentation] Update actions documentation to note that secondary checkouts will wipe the first checkout
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
- Domain
- ci-cd, documentation
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from actions/checkout
-
Difficulty 1/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
All issues in actions/checkout
Similar issues
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P3
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 76/100
-
code-quality refactoring
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
github/gh-aw-firewall#8816 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
vercel/react-tweet#225 ·