@@ -29,7 +29,7 @@ projects.
29
29
30
30
## System Requirements
31
31
32
- This framework is intended to be run on an Ubuntu 18 .04 system with some basic
32
+ This framework is intended to be run on an Ubuntu 20 .04 system with some basic
33
33
developer packages installed, such as git, and passwordless sudo enabled. Note
34
34
that it will automatically install various build-dependencies on the system, so
35
35
as a safety precaution it is currently restricted to only run on an AWS instance
@@ -48,14 +48,16 @@ This quick tutorial shows how to build the packages managed by this framework.
48
48
### Step 1. Create build VM
49
49
50
50
You need a system that meets the requirements above. For Delphix developers, you
51
- should clone the ` bootstrap-18-04 ` group on DCoA.
51
+ should clone the ` dlpx-internal-buildserver-develop ` group on DCoA.
52
52
53
53
### Step 2. Clone this repository
54
54
55
- Clone this repository on the build VM.
55
+ Clone this repository on the build VM. In order to clone this repository to the
56
+ build VM, you may need to specify a personal access token for authentication and
57
+ authorization.
56
58
57
59
```
58
- git clone https://github.com/delphix/linux-pkg.git
60
+ git clone https://<token>@ github.com/delphix/linux-pkg.git
59
61
```
60
62
61
63
### Step 3. Build a package
@@ -639,19 +641,31 @@ hook to `config.sh`. You should use the following functions provided by
639
641
* ` update_upstream_from_git() ` if ` UPSTREAM_GIT_URL ` & ` UPSTREAM_GIT_BRANCH ` are
640
642
set.
641
643
642
- #### Step 8. Add package to package-lists
644
+ #### Step 8. Make the package official
643
645
646
+ See [ Common Steps > Make the package official] ( #make-the-package-official ) .
647
+
648
+ #### Step 9. Submit a Pull Request for the new package
649
+
650
+ Once you verify that the package can be built, submit a pull request with only the
651
+ ` /packages/<package> ` chages. Once merged, this change will create a Jenkins job
652
+ ` (/linux-pkg/develop/build-package/<package>/pre-push) ` to
653
+ build the new package as part of the automation pipeline. Without merging these changes
654
+ first, we will not be able to test the automated build and integration into the appliance.
655
+
656
+ #### Step 10. Add package to package-lists
657
+
658
+ In a separate change, add the package to package-lists.
644
659
See [ Common Steps > Add package to package-lists] ( #add-package-to-package-lists ) .
645
660
646
- #### Step 9 . Test your changes
661
+ #### Step 11 . Test your changes
647
662
648
663
See section [ Testing Your Changes] ( #testing-your-changes ) .
649
664
650
- #### Step 10. Make the package official
665
+ #### Step 12. Submit a Pull-Request to add the package to package-lists
651
666
652
- See [ Common Steps > Make the package official] ( #make-the-package-official ) .
653
-
654
- #### Step 11. Submit a Pull-Request for your changes to linux-pkg
667
+ ** IMPORTANT** : This is the step which will trigger integration of this package into
668
+ the appliance.
655
669
656
670
### In-house package
657
671
@@ -753,7 +767,12 @@ TODO: complete section
753
767
754
768
### Testing changes to linux-pkg
755
769
756
- TODO: complete section
770
+ If you are testing a newly added package to linux-pkg:
771
+
772
+ 1 . Run ` git-ab-pre-push -b <package> ` from ` linux-pkg ` .
773
+
774
+ Note that this package must already have been added to ` /packages/ ` in the
775
+ ` develop ` branch, so that its specific Jenkins build job exists.
757
776
758
777
## Package Lists
759
778
@@ -819,7 +838,7 @@ environment variable.
819
838
820
839
When building packages for an older version of the Delphix Appliance, the build
821
840
image will need to be picked accordingly. We are currently using
822
- ` bootstrap-18-04 ` , but this will not be the case anymore once we switch to a
841
+ ` dlpx-internal-buildserver-develop ` , but this will not be the case anymore once we switch to a
823
842
newer Ubuntu distribution.
824
843
825
844
## Contributing
0 commit comments