Skip to content

Commit cc5d0e8

Browse files
authored
Merge pull request #4724 from DataDog/add-community-pr-appedix-to-development-guide
Add appendix section about community PRs
2 parents 42c3a4b + b411588 commit cc5d0e8

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

docs/DevelopmentGuide.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ This guide covers some of the common how-tos and technical reference material fo
1111
- [Checking code quality](#checking-code-quality)
1212
- [Appendix](#appendix)
1313
- [Writing new integrations](#writing-new-integrations)
14+
- [Community pull requests](#community-pull-requests)
1415

1516
## Setting up
1617

@@ -360,3 +361,48 @@ $ docker run \
360361
ruby:latest \
361362
./spec/datadog/tracing/contrib/grpc/support/gen_proto.sh
362363
```
364+
365+
### Community pull requests
366+
367+
> [!NOTE]
368+
> This is relevant for **internal** use only.
369+
370+
To trigger CI for community PRs, you need to clone the PR branch locally and
371+
push it to the `dd-trace-rb` repository. Here's how to do it using [GitHub CLI](https://cli.github.com/):
372+
373+
```console
374+
$ gh pr checkout 9999
375+
From github.com:DataDog/dd-trace-rb
376+
* [new ref] refs/pull/9999/head -> some-branch
377+
Switched to branch 'some-branch'
378+
```
379+
380+
Next, push that branch to the `dd-trace-rb` repository with an arbitrary name.
381+
For example, use `community/pr-9999`:
382+
383+
```console
384+
$ git push origin HEAD:community/pr-9999
385+
Enumerating objects: 45, done.
386+
Counting objects: 100% (42/42), done.
387+
Delta compression using up to 16 threads
388+
Compressing objects: 100% (25/25), done.
389+
Writing objects: 100% (25/25), 7.41 KiB | 7.41 MiB/s, done.
390+
Total 25 (delta 17), reused 0 (delta 0), pack-reused 0 (from 0)
391+
remote: Resolving deltas: 100% (17/17), completed with 15 local objects.
392+
remote:
393+
remote: Create a pull request for 'community/pr-9999' on GitHub by visiting:
394+
remote: https://github.com/DataDog/dd-trace-rb/pull/new/community/pr-9999
395+
remote:
396+
To github.com:DataDog/dd-trace-rb.git
397+
* [new branch] some-branch -> community/pr-9999
398+
```
399+
400+
Finally, create a draft PR with a clear title indicating this is a trigger PR
401+
that **should not** be merged:
402+
403+
```console
404+
$ gh pr create --draft --head community/pr-9999 --title "[IGNORE] Community PR 9999" --body ":warning: DO NOT MERGE :warning:"
405+
Creating pull request for community/pr-9999 into master in DataDog/dd-trace-rb
406+
407+
https://github.com/DataDog/dd-trace-rb/pull/0000
408+
```

0 commit comments

Comments
 (0)