From 469df6f25d341252f91f4e97a549f07e58dbe9fd Mon Sep 17 00:00:00 2001 From: Erik Hu Date: Wed, 15 Oct 2025 09:45:36 +0000 Subject: [PATCH 1/6] add documentation on how to fork --- TSF/README.md | 42 ++++++++++++++++++++++++++++++++++++++---- 1 file changed, 38 insertions(+), 4 deletions(-) diff --git a/TSF/README.md b/TSF/README.md index 1c88ff011a..2cc6b6b647 100644 --- a/TSF/README.md +++ b/TSF/README.md @@ -2,8 +2,42 @@ The TSF-related additions, such as the Trustable Graph and tooling extensions, are primarily organized within the TSF folder: - the items of the Trustable Graph are in `TSF/trustable` -- the documentation, which is built with the s-core doc-as-code tool, is placed in `TSF/docs` -- the report generated by [trudag](https://codethinklabs.gitlab.io/trustable/trustable/trudag/usage.html) is placed in `TSF/docs/generated`. This can either be produced as part of the CI pipeline or manually using `./TSF/scripts/generate_documentation.sh` -- the utility scripts in the `TSF/scripts` folder +- the building blocks of the documentation, which is built with the S-CORE docs-as-code tool, is placed in `TSF/docs` +- the report generated by [trudag](https://codethinklabs.gitlab.io/trustable/trustable/trudag/usage.html) is placed in `TSF/docs/generated`. This can either be produced as part of the CI pipeline or manually using `./TSF/scripts/generate_report.sh_`. It is strongly recommended that the TSF/docs folder is included in the .gitignore file +- the utility scripts are documented in the `TSF/scripts` folder -The TSF graph (including links, nodes and their hashes) is saved in the `.dotstop.dot` file and the trudag extensions including CPP test references are stored in the `.dotstop_extensions` folder since these locations are required by the trudag tool. \ No newline at end of file +The TSF graph (including links, nodes and their hashes) is saved in the `.dotstop.dot` file and the trudag extensions including CPP test references are stored in the `.dotstop_extensions` folder since these locations are required by the trudag tool. + +# Forking the repository + +In order to fork this repository or set up any repository where the TSF documentation in this repository is to be included, the following settings have to be configured on GitHub. + +- In `Settings` > `Features`: + - Enable `Issues` + +- In `Settings` > `Branches` > `Add classic branch protection rule`: + - Add "main" to the `Branch name pattern` + - Enable `Require a pull request before merging` + - Enable `Require approvals` + - Enable `Require review from Code Owners` + - Enable `Require status checks to pass before merging` + - Enable `Require branches to be up to date before merging` + - Enable `Require linear history` + - Enable `Do not allow bypassing the above settings` + - Click `Create` + +- In `Settings` > `Actions` > `General` > `Workflow Permissions`: + - Enable `Read repository contents and packages permissions` + - Disable `Allow GitHub Actions to create and approve pull requests` + - Click `Save` + +- In `Settings` > `Pages`: + - Under `Source`, select `GitHub Actions` + +- In `Settings` > `Advanced Security`: + - Enable `Dependency graph` + - Enable `Dependabot alerts` + +- In `Actions`: + - Click `I understand my workflows, go ahead and enable them` + - In the left side menu, click `Show more workflows...` and enable any workflows which are labelled as `Disabled` \ No newline at end of file From f05732661e7529b18bfba602e54c045686f51bbe Mon Sep 17 00:00:00 2001 From: Erik Hu Date: Wed, 15 Oct 2025 09:50:47 +0000 Subject: [PATCH 2/6] change branch name pattern --- TSF/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TSF/README.md b/TSF/README.md index 2cc6b6b647..45f4fd8ca9 100644 --- a/TSF/README.md +++ b/TSF/README.md @@ -16,7 +16,7 @@ In order to fork this repository or set up any repository where the TSF document - Enable `Issues` - In `Settings` > `Branches` > `Add classic branch protection rule`: - - Add "main" to the `Branch name pattern` + - Add "json_version_" to the `Branch name pattern` - Enable `Require a pull request before merging` - Enable `Require approvals` - Enable `Require review from Code Owners` From 5d224573194340fb5291bd2e5e4de6acff9cb825 Mon Sep 17 00:00:00 2001 From: Erik Hu Date: Wed, 15 Oct 2025 13:24:43 +0000 Subject: [PATCH 3/6] fix fnmatch pattern --- TSF/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TSF/README.md b/TSF/README.md index 45f4fd8ca9..63b80545a3 100644 --- a/TSF/README.md +++ b/TSF/README.md @@ -16,7 +16,7 @@ In order to fork this repository or set up any repository where the TSF document - Enable `Issues` - In `Settings` > `Branches` > `Add classic branch protection rule`: - - Add "json_version_" to the `Branch name pattern` + - Add "json_version_*" to the `Branch name pattern` - Enable `Require a pull request before merging` - Enable `Require approvals` - Enable `Require review from Code Owners` From 14c1e05fe50090102674356a41b2811385643cc3 Mon Sep 17 00:00:00 2001 From: Erik Hu Date: Tue, 21 Oct 2025 06:57:06 +0000 Subject: [PATCH 4/6] change master to main --- .github/CODEOWNERS | 2 -- TSF/README.md | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index e1e1040fc6..a7df14dde3 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -2,5 +2,3 @@ # Since 2013, over 250 contributors have helped to improve the library. # This CODEOWNERS file is only to make sure that @nlohmann is requested # for a code review in case of a pull request. - -* @nlohmann diff --git a/TSF/README.md b/TSF/README.md index 63b80545a3..2cc6b6b647 100644 --- a/TSF/README.md +++ b/TSF/README.md @@ -16,7 +16,7 @@ In order to fork this repository or set up any repository where the TSF document - Enable `Issues` - In `Settings` > `Branches` > `Add classic branch protection rule`: - - Add "json_version_*" to the `Branch name pattern` + - Add "main" to the `Branch name pattern` - Enable `Require a pull request before merging` - Enable `Require approvals` - Enable `Require review from Code Owners` From d1c3b3d9bb68ddf476a8ef05153023cba58b08d2 Mon Sep 17 00:00:00 2001 From: Erik Hu Date: Tue, 21 Oct 2025 12:42:24 +0000 Subject: [PATCH 5/6] correct forking docs --- TSF/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TSF/README.md b/TSF/README.md index 2cc6b6b647..1c7b446da2 100644 --- a/TSF/README.md +++ b/TSF/README.md @@ -38,6 +38,6 @@ In order to fork this repository or set up any repository where the TSF document - Enable `Dependency graph` - Enable `Dependabot alerts` -- In `Actions`: +- In `Actions tab`: - Click `I understand my workflows, go ahead and enable them` - In the left side menu, click `Show more workflows...` and enable any workflows which are labelled as `Disabled` \ No newline at end of file From fb5481ab67a1954073a8e39510342f1f9dcb1f44 Mon Sep 17 00:00:00 2001 From: Erik Hu Date: Wed, 22 Oct 2025 15:06:10 +0000 Subject: [PATCH 6/6] implement feedback --- TSF/README.md | 44 +++++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/TSF/README.md b/TSF/README.md index 1c7b446da2..8351399df1 100644 --- a/TSF/README.md +++ b/TSF/README.md @@ -12,31 +12,33 @@ The TSF graph (including links, nodes and their hashes) is saved in the `.dotsto In order to fork this repository or set up any repository where the TSF documentation in this repository is to be included, the following settings have to be configured on GitHub. -- In `Settings` > `Features`: +- In `Settings` > `General` >`Features`: - Enable `Issues` -- In `Settings` > `Branches` > `Add classic branch protection rule`: - - Add "main" to the `Branch name pattern` - - Enable `Require a pull request before merging` - - Enable `Require approvals` - - Enable `Require review from Code Owners` - - Enable `Require status checks to pass before merging` - - Enable `Require branches to be up to date before merging` - - Enable `Require linear history` - - Enable `Do not allow bypassing the above settings` - - Click `Create` - -- In `Settings` > `Actions` > `General` > `Workflow Permissions`: - - Enable `Read repository contents and packages permissions` - - Disable `Allow GitHub Actions to create and approve pull requests` - - Click `Save` - -- In `Settings` > `Pages`: +- In `Settings` > `Code and automation` > `Branches`: + - Click `Add classic branch protection rule` and add "main" to the `Branch name pattern` + - Make sure that only the following settings are enabled: + - `Require a pull request before merging` + - `Require approvals` + - `Require review from Code Owners` + - `Require status checks to pass before merging` + - `Require branches to be up to date before merging` + - `Require linear history` + - `Do not allow bypassing the above settings` + +- In `Settings` > `Code and automation` > `Actions` > `General` > `Workflow Permissions`: + - Make sure that only the following settings are enabled: + - `Allow all actions and reusable workflows` + - `Require approval for first-time contributors` + - `Read repository contents and packages permissions` + +- In `Settings` > `Code and automation` > `Pages`: - Under `Source`, select `GitHub Actions` -- In `Settings` > `Advanced Security`: - - Enable `Dependency graph` - - Enable `Dependabot alerts` +- In `Settings` > `Security` > `Advanced Security`: + - Make sure that only the following settings are enabled: + - `Dependency graph` + - `Dependabot alerts` - In `Actions tab`: - Click `I understand my workflows, go ahead and enable them`