add forking guide #1731

AlexanderLanin · 2025-09-15T12:53:30Z

Add an "Enterprise Forking Guide for S-CORE Repositories"

Content is up to lots of discussions :-)

Copilot

Pull Request Overview

This PR introduces an "Enterprise Forking Guide for S-CORE Repositories" to help companies understand how to structure forks effectively for both internal development and upstream contribution. The guide provides a decision framework for organizations managing both private and public code flows.

Comprehensive forking strategy documentation covering public, internal, and hybrid approaches
Practical implementation guidance including workflows, tooling (Copybara), and CI integration
Technical examples for git workflows and repository management

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File	Description
docs/contribute/index.rst	Adds fork/index to the documentation table of contents
docs/contribute/fork/index.md	New comprehensive guide covering enterprise forking strategies, workflows, and tooling

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-15T12:54:46Z

docs/contribute/fork/index.md

+
+---
+
+## Rest, unsorted


This section header indicates incomplete organization. Consider creating proper section titles and organizing the content appropriately before merging, or remove this placeholder heading if the content below is intentionally unsorted.

Suggested change

## Rest, unsorted

## Transformation and Filtering Pipelines

Copilot · 2025-09-15T12:54:47Z

docs/contribute/fork/index.md

+
+Prefer GitHub Apps for automated CI access where possible; fine-grained PATs increase token-management overhead and invite accidental long-lived credential exposure.
+
+TODO: add short examples and links to recommended app installation steps.


This TODO comment indicates incomplete documentation. Either complete the missing examples and links or remove this line if the information will be added in a follow-up PR.

Suggested change

TODO: add short examples and links to recommended app installation steps.

**Example:**

To automate CI access, create or install a [GitHub App](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app) with only the permissions your workflow needs (e.g., `contents: read`, `pull requests: write`).

- [Installing a GitHub App on your organization](https://docs.github.com/en/apps/using-github-apps/installing-github-apps)

- [Configuring permissions for a GitHub App](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app#choosing-permissions)

Copilot · 2025-09-15T12:54:48Z

docs/contribute/fork/index.md

+  app_id: ${{ secrets.GH_APP_ID }}
+  private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}


The YAML indentation is inconsistent. The app_id and private_key lines should be indented to align with the with: block above them.

Suggested change

app_id: ${{ secrets.GH_APP_ID }}

private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}

app_id: ${{ secrets.GH_APP_ID }}

private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}

Copilot · 2025-09-15T12:54:48Z

docs/contribute/fork/index.md

+  git config --global user.name  "Qorix Bot"
+  git config --global user.email "bot@qorix.dev"
+  echo "https://x-access-token:${{ steps.generate_token.outputs.token }}@github.com" > ~/.git-credentials
+
+- name: Run Copybara
+  run: |
+  sed -i "s/{{BRANCH}}/${{ github.event.inputs.branch_name }}/g" copy.bara.sky
+  curl -LO https://github.com/qorix-group/copybara/releases/download/v20250508/copybara_deploy.jar
+  java -jar copybara_deploy.jar migrate copy.bara.sky publish_branch


The YAML indentation is inconsistent. Lines 283-285 should be indented properly under the run: | block.

Suggested change

git config --global user.name "Qorix Bot"

git config --global user.email "bot@qorix.dev"

echo "https://x-access-token:${{ steps.generate_token.outputs.token }}@github.com" > ~/.git-credentials

- name: Run Copybara

run: |

sed -i "s/{{BRANCH}}/${{ github.event.inputs.branch_name }}/g" copy.bara.sky

curl -LO https://github.com/qorix-group/copybara/releases/download/v20250508/copybara_deploy.jar

java -jar copybara_deploy.jar migrate copy.bara.sky publish_branch

git config --global user.name "Qorix Bot"

git config --global user.email "bot@qorix.dev"

echo "https://x-access-token:${{ steps.generate_token.outputs.token }}@github.com" > ~/.git-credentials

- name: Run Copybara

run: |

sed -i "s/{{BRANCH}}/${{ github.event.inputs.branch_name }}/g" copy.bara.sky

curl -LO https://github.com/qorix-group/copybara/releases/download/v20250508/copybara_deploy.jar

java -jar copybara_deploy.jar migrate copy.bara.sky publish_branch

Copilot · 2025-09-15T12:54:49Z

docs/contribute/fork/index.md

+  sed -i "s/{{BRANCH}}/${{ github.event.inputs.branch_name }}/g" copy.bara.sky
+  curl -LO https://github.com/qorix-group/copybara/releases/download/v20250508/copybara_deploy.jar
+  java -jar copybara_deploy.jar migrate copy.bara.sky publish_branch


The YAML indentation is inconsistent. Lines 289-290 should be indented properly under the run: | block.

Suggested change

sed -i "s/{{BRANCH}}/${{ github.event.inputs.branch_name }}/g" copy.bara.sky

curl -LO https://github.com/qorix-group/copybara/releases/download/v20250508/copybara_deploy.jar

java -jar copybara_deploy.jar migrate copy.bara.sky publish_branch

sed -i "s/{{BRANCH}}/${{ github.event.inputs.branch_name }}/g" copy.bara.sky

curl -LO https://github.com/qorix-group/copybara/releases/download/v20250508/copybara_deploy.jar

java -jar copybara_deploy.jar migrate copy.bara.sky publish_branch

indentation was changed by copilot from 4 to 2 spaces... 😮‍💨

github-actions · 2025-09-15T12:57:30Z

The created documentation from the pull request is available at: docu-html

johannes-esr · 2025-09-15T14:26:29Z

docs/contribute/fork/index.md

+Constraints
+
+- Requires internal infrastructure and operational processes to manage branches, reviews, and syncing.
+- Demands disciplined synchronization from upstream to avoid painful drift and costly merges.
+- Typically increases TTM (time-to-merge) for open contributions; may hinder collaborative workflows.


Another constraint is that it's hatd to deal with code reviews in the PR in S-CORE itself. Are the requested adaptions then directly done in the public or again first internally?

johannes-esr · 2025-09-15T14:31:06Z

docs/contribute/fork/index.md

+The default remote names will be:
+
+- `origin`: your fork (e.g. `my_company/score`)
+- `upstream`: the original repo (e.g. `eclipse-score/score`)


Do you know whether one can raise a PR from a non-public fork to S-CORE?

See internal-fork description.
--> "No contributions possible."

nradakovic

LGTM just add examples for it (as you already set in TODO)

AlexanderLanin · 2025-09-18T20:57:24Z

I'll merge this as-is and resolve TODO in a future PR.

add forking guide

24ce5cc

Copilot AI review requested due to automatic review settings September 15, 2025 12:53

AlexanderLanin requested a review from a team as a code owner September 15, 2025 12:53

Copilot AI reviewed Sep 15, 2025

View reviewed changes

johannes-esr reviewed Sep 15, 2025

View reviewed changes

nradakovic approved these changes Sep 17, 2025

View reviewed changes

dcalavrezo-qorix approved these changes Sep 18, 2025

View reviewed changes

AlexanderLanin merged commit 9f2308e into main Sep 18, 2025
8 checks passed

AlexanderLanin deleted the fork branch September 18, 2025 20:57

masc2023 pushed a commit to esrlabs/score that referenced this pull request Oct 8, 2025

add forking guide (eclipse-score#1731)

6f4d837


		Prefer GitHub Apps for automated CI access where possible; fine-grained PATs increase token-management overhead and invite accidental long-lived credential exposure.

		TODO: add short examples and links to recommended app installation steps.

-TODO: add short examples and links to recommended app installation steps.
+**Example:**
+To automate CI access, create or install a [GitHub App](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app) with only the permissions your workflow needs (e.g., `contents: read`, `pull requests: write`).
+- [Installing a GitHub App on your organization](https://docs.github.com/en/apps/using-github-apps/installing-github-apps)
+- [Configuring permissions for a GitHub App](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app#choosing-permissions)

		app_id: ${{ secrets.GH_APP_ID }}
		private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}

add forking guide #1731

add forking guide #1731

Uh oh!

Conversation

AlexanderLanin commented Sep 15, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Sep 15, 2025

Uh oh!

johannes-esr Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

johannes-esr Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

nradakovic left a comment

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin commented Sep 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants