-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(build): updating default/build branch from master to develop (#89)
* updating branch reference from master to develop in following files: - CONTRIBUTING.md - GOVERNANCE.md - README.md - RELEASE.md - buildscripts/install-test-dep.sh - code-standard.md - developer-setup.md * chore(workflow): push images to ghcr Signed-off-by: mayank <[email protected]>
- Loading branch information
Showing
10 changed files
with
71 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| This is a OpenEBS sub project and abides by the | ||
| [OpenEBS Project Governance](https://github.com/openebs/openebs/blob/master/GOVERNANCE.md). | ||
| [OpenEBS Project Governance](https://github.com/openebs/openebs/blob/HEAD/GOVERNANCE.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
|
|
||
| ## Sign your commits | ||
|
|
||
| We use the Developer Certificate of Origin (DCO) as an additional safeguard for the OpenEBS projects. This is a well established and widely used mechanism to assure that contributors have confirmed their right to license their contribution under the project's license. Please read [dcofile](https://github.com/openebs/openebs/blob/master/contribute/developer-certificate-of-origin). If you can certify it, then just add a line to every git commit message: | ||
| We use the Developer Certificate of Origin (DCO) as an additional safeguard for the OpenEBS projects. This is a well established and widely used mechanism to assure that contributors have confirmed their right to license their contribution under the project's license. Please read [dcofile](https://github.com/openebs/openebs/blob/HEAD/contribute/developer-certificate-of-origin). If you can certify it, then just add a line to every git commit message: | ||
|
|
||
| ```` | ||
| Signed-off-by: Random J Developer <[email protected]> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -58,7 +58,7 @@ git clone https://github.com/$user/libcstor.git | |
| cd libcstor | ||
| git remote add upstream https://github.com/openebs/libcstor.git | ||
|
|
||
| # Never push to upstream master | ||
| # Never push to upstream develop | ||
| git remote set-url --push upstream no_push | ||
|
|
||
| # Confirm that your remotes make sense: | ||
|
|
@@ -99,7 +99,7 @@ git remote -v | |
|
|
||
| * Test your changes | ||
|
|
||
| Integration tests are written in c and c+. Test script is maintained at https://github.com/openebs/libcstor/blob/master/tests/cstor/script/test_uzfs.sh | ||
| Integration tests are written in c and c+. Test script is maintained at https://github.com/openebs/libcstor/blob/HEAD/tests/cstor/script/test_uzfs.sh | ||
| To run the run the integration tests go to cstor directory and run below command. | ||
| ```sh | ||
| ../libcstor/tests/cstor/script/test_uzfs.sh -T all | ||
|
|
@@ -114,15 +114,15 @@ Open a terminal on your local machine. Change directory to the libcstor fork roo | |
| $ cd libcstor | ||
| ``` | ||
|
|
||
| Check out the master branch. | ||
| Check out the develop branch. | ||
|
|
||
| ```sh | ||
| $ git checkout master | ||
| Switched to branch 'master' | ||
| Your branch is up-to-date with 'origin/master'. | ||
| $ git checkout develop | ||
| Switched to branch 'develop' | ||
| Your branch is up-to-date with 'origin/develop'. | ||
| ``` | ||
|
|
||
| Recall that origin/master is a branch on your remote GitHub repository. | ||
| Recall that origin/develop is a branch on your remote GitHub repository. | ||
| Make sure you have the upstream remote openebs/libcstor by listing them. | ||
|
|
||
| ```sh | ||
|
|
@@ -138,60 +138,60 @@ $ cd libcstor | |
| ```sh | ||
| $ git remote add upstream https://github.com/openebs/libcstor.git | ||
| ``` | ||
| Fetch all the changes from the upstream master branch. | ||
| Fetch all the changes from the upstream develop branch. | ||
|
|
||
| ```sh | ||
| $ git fetch upstream master | ||
| $ git fetch upstream develop | ||
| remote: Counting objects: 141, done. | ||
| remote: Compressing objects: 100% (29/29), done. | ||
| remote: Total 141 (delta 52), reused 46 (delta 46), pack-reused 66 | ||
| Receiving objects: 100% (141/141), 112.43 KiB | 0 bytes/s, done. | ||
| Resolving deltas: 100% (79/79), done. | ||
| From github.com:openebs/libcstor | ||
| * branch master -> FETCH_HEAD | ||
| * branch develop -> FETCH_HEAD | ||
| ``` | ||
|
|
||
| Rebase your local master with the upstream/master. | ||
| Rebase your local develop with the upstream/develop. | ||
|
|
||
| ```sh | ||
| $ git rebase upstream/master | ||
| $ git rebase upstream/develop | ||
| First, rewinding head to replay your work on top of it... | ||
| Fast-forwarded master to upstream/master. | ||
| Fast-forwarded develop to upstream/develop. | ||
| ``` | ||
| This command applies all the commits from the upstream master to your local master. | ||
| This command applies all the commits from the upstream develop to your local develop. | ||
|
|
||
| Check the status of your local branch. | ||
|
|
||
| ```sh | ||
| $ git status | ||
| On branch master | ||
| Your branch is ahead of 'origin/master' by 12 commits. | ||
| On branch develop | ||
| Your branch is ahead of 'origin/develop' by 12 commits. | ||
| (use "git push" to publish your local commits) | ||
| nothing to commit, working directory clean | ||
| ``` | ||
| Your local repository now has all the changes from the upstream remote. You need to push the changes to your remote fork which is origin master. | ||
| Your local repository now has all the changes from the upstream remote. You need to push the changes to your remote fork which is origin develop. | ||
|
|
||
| Push the rebased master to origin master. | ||
| Push the rebased develop to origin develop. | ||
|
|
||
| ```sh | ||
| $ git push origin master | ||
| $ git push origin develop | ||
| Username for 'https://github.com': $user | ||
| Password for 'https://[email protected]': | ||
| Counting objects: 223, done. | ||
| Compressing objects: 100% (38/38), done. | ||
| Writing objects: 100% (69/69), 8.76 KiB | 0 bytes/s, done. | ||
| Total 69 (delta 53), reused 47 (delta 31) | ||
| To https://github.com/$user/libcstor.git | ||
| 8e107a9..5035fa1 master -> master | ||
| 8e107a9..5035fa1 develop -> develop | ||
| ``` | ||
|
|
||
| ### Contributing to a feature or bugfix. | ||
|
|
||
| Always start with creating a new branch from master to work on a new feature or bugfix. Your branch name should have the format XX-descriptive where XX is the issue number you are working on followed by some descriptive text. For example: | ||
| Always start with creating a new branch from develop to work on a new feature or bugfix. Your branch name should have the format XX-descriptive where XX is the issue number you are working on followed by some descriptive text. For example: | ||
|
|
||
| ```sh | ||
| $ git checkout master | ||
| # Make sure the master is rebased with the latest changes as described in the previous step. | ||
| $ git checkout develop | ||
| # Make sure the develop is rebased with the latest changes as described in the previous step. | ||
| $ git checkout -b 1234-fix-developer-docs | ||
| Switched to a new branch '1234-fix-developer-docs' | ||
| ``` | ||
|
|
@@ -204,7 +204,7 @@ Happy Hacking! | |
| ```sh | ||
| # While on your myfeature branch (see above) | ||
| git fetch upstream | ||
| git rebase upstream/master | ||
| git rebase upstream/develop | ||
| ``` | ||
|
|
||
| While you rebase your changes, you must resolve any conflicts that might arise and build and test your changes using the above steps. | ||
|
|
||