Skip to content

Commit a3eca0a

Browse files
authored
TOOL-24936 linux-pkg README.md still refers to old-world branching (#308)
PR URL: https://www.github.com/delphix/linux-pkg/pull/308
1 parent 77990a6 commit a3eca0a

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -97,37 +97,37 @@ we've decided to leverage the advantages offered by revision control. As such,
9797
we've adopted a well defined branching model for each third-party package.
9898

9999
First of all, we have a Delphix repository on github for each third-party
100-
package that we build. Each repository has at least 2 branches: **6.0/stage** and
101-
**upstreams/6.0/stage**. The **6.0/stage** branch of the package is the one we build,
102-
and contains Delphix changes. The **upstreams/6.0/stage** branch is used to track
100+
package that we build. Each repository has at least 2 branches: **develop** and
101+
**upstreams/develop**. The **develop** branch of the package is the one we build,
102+
and contains Delphix changes. The **upstreams/develop** branch is used to track
103103
the upstream version of the package. For packages that are not provided by
104-
Ubuntu but are available on git, the **upstreams/6.0/stage** branch usually just
105-
tracks the **6.0/stage** branch of the project. For packages that are provided by
106-
Ubuntu, the **upstreams/6.0/stage** branch instead tracks the source package that
104+
Ubuntu but are available on git, the **upstreams/develop** branch usually just
105+
tracks the **develop** branch of the project. For packages that are provided by
106+
Ubuntu, the **upstreams/develop** branch instead tracks the source package that
107107
is maintained by Ubuntu (i.e. the branch contains the files obtained from
108108
`apt-get source <source-package>`). This offers the advantage of using a version
109109
of the package tuned to work with our Ubuntu distribution.
110110

111-
When updating a package, we first check if the **upstreams/6.0/stage** branch is
111+
When updating a package, we first check if the **upstreams/develop** branch is
112112
up-to-date, by fetching the latest version of the upstream git repository or the
113113
Ubuntu source package. If changes are detected, we update the
114-
**upstreams/6.0/stage** branch and push the changes to GitHub.
114+
**upstreams/develop** branch and push the changes to GitHub.
115115

116-
The second step is to check if the **6.0/stage** branch is up-to-date with
117-
**upstreams/6.0/stage**. If it is already up-to-date, then we are done. If not,
118-
then we attempt merging **upstreams/6.0/stage** into **6.0/stage**.
116+
The second step is to check if the **develop** branch is up-to-date with
117+
**upstreams/develop**. If it is already up-to-date, then we are done. If not,
118+
then we attempt merging **upstreams/develop** into **develop**.
119119

120120
If the merge is successful, then we push the changes to a staging branch on
121-
GitHub, called **projects/auto-update/6.0/stage/merging**. The intent is for
121+
GitHub, called **projects/auto-update/develop/merging**. The intent is for
122122
a different system to fetch those changes, build them, and then launch tests.
123123

124124
See [Scripts > sync-with-upstream.sh](#sync-with-upstreamsh) below.
125125

126126
Once the merge has been tested, [Scripts > push-merge.sh](#push-mergesh) is
127-
called on the original VM to push the changes to the **6.0/stage** branch on
127+
called on the original VM to push the changes to the **develop** branch on
128128
GitHub.
129129

130-
Note that the example above targets the **6.0/stage** branch, but the same
130+
Note that the example above targets the **develop** branch, but the same
131131
workflow could apply to other branches.
132132

133133
## Scripts
@@ -188,19 +188,19 @@ Usage:
188188

189189
This script has 2 tasks:
190190
1. Check if the upstream project has updates that are not pulled into the
191-
**upstreams/6.0/stage** branch of the package, and if so then update that branch
191+
**upstreams/develop** branch of the package, and if so then update that branch
192192
and push changes to GitHub.
193-
2. Merge **upstreams/6.0/stage** into **6.0/stage** and push the changes to a staging
194-
branch on GitHub, called **projects/auto-update/6.0/stage/merging**. Another
193+
2. Merge **upstreams/develop** into **develop** and push the changes to a staging
194+
branch on GitHub, called **projects/auto-update/develop/merging**. Another
195195
system should use that branch to build the package, and then run the appropriate
196196
integration tests.
197197

198198
After testing has been completed, `push-merge.sh <package>` should be called on
199-
the same system to push the merge to the **6.0/stage** branch.
199+
the same system to push the merge to the **develop** branch.
200200

201201
Note that the DRYRUN environment variable must be set when running this script.
202202
If DRYRUN is set to "true", then changes are not pushed to GitHub in step 1,
203-
and staged changes are pushed to **projects/auto-update/6.0/stage/merging-dryrun**
203+
and staged changes are pushed to **projects/auto-update/develop/merging-dryrun**
204204
in step 2 instead of the non-dryrun branch. The intention is that when testing
205205
changes to the logic we want to be able to run most of the logic, but without
206206
affecting the production branches.
@@ -214,8 +214,8 @@ Usage:
214214

215215
This must be called on a system that has previously called
216216
`sync-with-upstream.sh` for the same package. It will push the merge that was
217-
previously prepared by `sync-with-upstream.sh` to the production **6.0/stage**
218-
branch, after checking that the **6.0/stage** branch hasn't been modified since
217+
previously prepared by `sync-with-upstream.sh` to the production **develop**
218+
branch, after checking that the **develop** branch hasn't been modified since
219219
`sync-with-upstream.sh` was called.
220220

221221
Like for `sync-with-upstream.sh`, the DRYRUN environment variable must be set
@@ -246,7 +246,7 @@ of some of the scripts defined above.
246246

247247
* **DEFAULT_GIT_BRANCH**: The product branch that is being built or updated
248248
and must be set via DEFAULT_GIT_BRANCH. It can either be set to a
249-
development branch, such as "6.0/stage", or a release tag, such as
249+
development branch, such as "develop", or a release tag, such as
250250
"release/6.0.6.0".
251251
The product branch is used in multiple instances. When
252252
running [setup.sh](#setupsh), it will determine what linux-package-mirror
@@ -382,7 +382,7 @@ The `fetch()` hook is optional, as a default is provided and should be used. It
382382
is called when fetching the source code of the package to build or to update.
383383
The repository is cloned into `<WORKDIR>/repo` and checked out as
384384
branch **repo-HEAD**. If we are performing a package update, then we also
385-
fetch the **upstreams/6.0/stage** branch into **upstream-HEAD**. The default
385+
fetch the **upstreams/develop** branch into **upstream-HEAD**. The default
386386
should only be overridden when not fetching the package source from git.
387387

388388
#### Prepare (hook)
@@ -401,7 +401,7 @@ The `update_upstream()` hook should only be defined for third party packages
401401
that can be auto-updated. It is responsible for fetching the latest upstream
402402
source code on top of branch **upstream-HEAD** of our fetched repository in
403403
`<WORKDIR>/repo`. Note that any changes should be rebased on top of
404-
the **upstreams/6.0/stage** branch. If changes are detected, file
404+
the **upstreams/develop** branch. If changes are detected, file
405405
`<WORKDIR>/upstream-updated` should be created.
406406

407407
#### Merge With Upstream (hook)
@@ -551,8 +551,8 @@ UPSTREAM_GIT_BRANCH="<git branch>"
551551

552552
Note that steps 3 to 5 are most useful when getting a third party package from
553553
an Ubuntu source package. When the third party package is fetched from git,
554-
you may simply fork the upstream repository and add an **upstreams/6.0/stage**
555-
branch that points to the **6.0/stage** branch; you can then update
554+
you may simply fork the upstream repository and add an **upstreams/develop**
555+
branch that points to the **develop** branch; you can then update
556556
`DEFAULT_PACKAGE_GIT_URL` in config.sh to your forked git repository and skip
557557
to step 6.
558558

@@ -590,8 +590,8 @@ DEFAULT_PACKAGE_GIT_URL="https://github.com/<developer>/<package>"
590590
#### Step 5. Push to your developer repository
591591

592592
Next step is to push the upstream code to the newly created repository to your
593-
developer repository. You should push the initial commit to both the **6.0/stage**
594-
branch and the **upstreams/6.0/stage** branch.
593+
developer repository. You should push the initial commit to both the **develop**
594+
branch and the **upstreams/develop** branch.
595595

596596
#### Step 6. Build the package
597597

@@ -617,7 +617,7 @@ build the package.
617617

618618
For a package that doesn't have a `debian` metadata directory already defined in
619619
its source tree, you'll need to create it, and push the changes to the
620-
**6.0/stage** branch of your developer repository. See
620+
**develop** branch of your developer repository. See
621621
[Common Steps > Creating debian metadirectory](#creating-debian-metadirectory)
622622
for more details.
623623

@@ -728,9 +728,9 @@ is to create an official repository for it.
728728
[Delphix Open-Source Policy](https://docs.delphix.com/en/ip-strategy/outbound-open-source)
729729
if you haven't already, and provide the necessary info so that a
730730
`github.com/delphix/<package>` repository can be created for it. You'll need
731-
to push the **6.0/stage** branch from your developer repository, as well as the
732-
**upstreams/6.0/stage** branch if it is a third-party package. Note that if you
733-
have modified **6.0/stage** (i.e. it diverges from **upstreams/6.0/stage**), you
731+
to push the **develop** branch from your developer repository, as well as the
732+
**upstreams/develop** branch if it is a third-party package. Note that if you
733+
have modified **develop** (i.e. it diverges from **upstreams/develop**), you
734734
should submit your changes for review before pushing them.
735735

736736
1. If this is a third-party package that is to be auto-updated by Delphix

0 commit comments

Comments
 (0)