From 1194eca861faeb28387efe611e06cc044d5e9501 Mon Sep 17 00:00:00 2001 From: Gary O'Neall Date: Thu, 14 Nov 2024 10:24:28 -0800 Subject: [PATCH 1/6] Add branch strategy to README Signed-off-by: Gary O'Neall --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index c83874a1dc..3b14b0a6a0 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,16 @@ This repository consists of these files and directories (partial): - `mkdocs.yml` - MkDocs recipe for the spec documentation generation. The inclusion of model files and the order of chapters are defined here. +## Branch structre + +The SPDX spec repo follows the [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow with the addition of support branches. + +The branches in use are: +- main - This will always be the latest released specification. +- develop - This branch will be where the active development for the next major or minor version will take place. Once relased, the develop branch will be merged into the main branch. +- support/x.y - These branches will be long lived and contain any updates to a minor version of the specification. Additions such as translations can be added to the support branch. x.y represents the major/minor version. Once any changes are accepted and released, the support branch will be tagged and merged into both the develop and main branches. +- general feature or fix branches - there may be feature branches made for specific enhancements or fixes to the spec. These will be short lived and merged into either a support branch or the develop branch. + ## Related documents and repositories | Documentation | Link | From f376617af21038ba32ed4968dedbd3307a330363 Mon Sep 17 00:00:00 2001 From: Gary O'Neall Date: Thu, 14 Nov 2024 15:00:58 -0800 Subject: [PATCH 2/6] Update per suggestion Co-authored-by: Arthit Suriyawongkul Signed-off-by: Gary O'Neall --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b14b0a6a0..f40fde1c34 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ The SPDX spec repo follows the [Gitflow](https://www.atlassian.com/git/tutorials The branches in use are: - main - This will always be the latest released specification. -- develop - This branch will be where the active development for the next major or minor version will take place. Once relased, the develop branch will be merged into the main branch. +- `develop` - This branch will be where the active development for the next major or minor version takes place. Once released, the `develop` branch will be merged into the `main` branch. - support/x.y - These branches will be long lived and contain any updates to a minor version of the specification. Additions such as translations can be added to the support branch. x.y represents the major/minor version. Once any changes are accepted and released, the support branch will be tagged and merged into both the develop and main branches. - general feature or fix branches - there may be feature branches made for specific enhancements or fixes to the spec. These will be short lived and merged into either a support branch or the develop branch. From a1dc41566a1de79ccd0db916e46d9949efb99c0e Mon Sep 17 00:00:00 2001 From: Gary O'Neall Date: Thu, 14 Nov 2024 15:01:08 -0800 Subject: [PATCH 3/6] Update per suggestion Co-authored-by: Arthit Suriyawongkul Signed-off-by: Gary O'Neall --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f40fde1c34..cd7a2c5a27 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,8 @@ This repository consists of these files and directories (partial): The SPDX spec repo follows the [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow with the addition of support branches. The branches in use are: -- main - This will always be the latest released specification. + +- `main` - This will always be the latest released specification. - `develop` - This branch will be where the active development for the next major or minor version takes place. Once released, the `develop` branch will be merged into the `main` branch. - support/x.y - These branches will be long lived and contain any updates to a minor version of the specification. Additions such as translations can be added to the support branch. x.y represents the major/minor version. Once any changes are accepted and released, the support branch will be tagged and merged into both the develop and main branches. - general feature or fix branches - there may be feature branches made for specific enhancements or fixes to the spec. These will be short lived and merged into either a support branch or the develop branch. From e9b19bb1372aea48ef6bdd654c75947348836603 Mon Sep 17 00:00:00 2001 From: Gary O'Neall Date: Thu, 14 Nov 2024 15:01:26 -0800 Subject: [PATCH 4/6] Update per suggestion Co-authored-by: Arthit Suriyawongkul Signed-off-by: Gary O'Neall --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cd7a2c5a27..6e8575b67d 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ The branches in use are: - `main` - This will always be the latest released specification. - `develop` - This branch will be where the active development for the next major or minor version takes place. Once released, the `develop` branch will be merged into the `main` branch. -- support/x.y - These branches will be long lived and contain any updates to a minor version of the specification. Additions such as translations can be added to the support branch. x.y represents the major/minor version. Once any changes are accepted and released, the support branch will be tagged and merged into both the develop and main branches. +- `support/x.y` - These branches will be long lived and contain any updates to a minor version of the specification. Additions such as translations can be added to the support branch. `x.y` represents the major.minor version. Once any changes are accepted and released, the support branch will be tagged and merged into both the develop and main branches. - general feature or fix branches - there may be feature branches made for specific enhancements or fixes to the spec. These will be short lived and merged into either a support branch or the develop branch. ## Related documents and repositories From 01b1c2e6c7db32a07d9d585fdd1ae8f9c3267c21 Mon Sep 17 00:00:00 2001 From: Gary O'Neall Date: Thu, 14 Nov 2024 15:01:43 -0800 Subject: [PATCH 5/6] Update per suggestion Co-authored-by: Arthit Suriyawongkul Signed-off-by: Gary O'Neall --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e8575b67d..d8daca191c 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ The branches in use are: - `main` - This will always be the latest released specification. - `develop` - This branch will be where the active development for the next major or minor version takes place. Once released, the `develop` branch will be merged into the `main` branch. - `support/x.y` - These branches will be long lived and contain any updates to a minor version of the specification. Additions such as translations can be added to the support branch. `x.y` represents the major.minor version. Once any changes are accepted and released, the support branch will be tagged and merged into both the develop and main branches. -- general feature or fix branches - there may be feature branches made for specific enhancements or fixes to the spec. These will be short lived and merged into either a support branch or the develop branch. +- General feature or fix branches - there may be feature branches made for specific enhancements or fixes to the spec. These will be short lived and merged into either a support branch or the develop branch. ## Related documents and repositories From 48541910962e2c9a51bcbe72f54c2050f6b4f19b Mon Sep 17 00:00:00 2001 From: Gary O'Neall Date: Fri, 15 Nov 2024 10:36:40 -0800 Subject: [PATCH 6/6] Update Gitflow link per suggestion Signed-off-by: Gary O'Neall --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d8daca191c..51a7944d9b 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ This repository consists of these files and directories (partial): ## Branch structre -The SPDX spec repo follows the [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow with the addition of support branches. +The SPDX spec repo follows the [Gitflow](https://gist.github.com/HeratPatel/271b5d2304de2e2cd1823b9b62bf43e0) workflow with the addition of support branches. The branches in use are: