Details
-
Type:
Bug
-
Status: Closed (View Workflow)
-
Priority:
Major
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:
-
Story Points:2
-
Epic Link:
-
Sprint:Winter 2018 Sprint 2, Winter 2018 Sprint 3, Summer 2019 Sprint 10, Summer 2019 Sprint 11
Description
Whenever we do a release of IGB, we have to hard-code the IGB version string.
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings with value parsed from root POM.xml version string.
For an example, see how this is being done for Genoviz SDK build process.
Note: the most complicated aspect of this will probably be figuring out how to create the version string used in the IGB installer names, which use underscore characters instead of periods.
Note: Srishti Tiwari worked on this previously. The issue description previously recommend testing the build environment and process using Docker image running on a local host. See comments.
Attachments
Issue Links
Activity
| Field | Original Value | New Value |
|---|---|---|
| Sprint | Early Fall 2017 [ 47 ] |
| Rank | Ranked higher |
| Rank | Ranked higher |
| Description | Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings (e.g., 9.0.1 in curl command) with references to IGB_VERSION environment variable. |
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings (e.g., 9.0.1 in curl command) with placeholder to allow editing of this variable during the build process. Options: 1) Insert value from a bitbucket pipeline environment variable, added manually by developer 2) Parse version string from IGB code files (pom.xml or properties file?) Alternatively, parse IGB version string from IGB project directly. |
| Description |
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings (e.g., 9.0.1 in curl command) with placeholder to allow editing of this variable during the build process. Options: 1) Insert value from a bitbucket pipeline environment variable, added manually by developer 2) Parse version string from IGB code files (pom.xml or properties file?) Alternatively, parse IGB version string from IGB project directly. |
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings (e.g., 9.0.1 in curl command) with placeholder to allow editing of this variable during the build process. Options: 1) Insert value from a bitbucket pipeline environment variable, added manually by developer 2) Parse version string from IGB code files (pom.xml or properties file?) |
| Assignee | Sanket Patil [ spatil26 ] |
| Assignee | Ann Loraine [ aloraine ] |
| Fix Version/s | 9.0.2 [ 10600 ] | |
| Story Points | 0.25 | 1 |
| Description |
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings (e.g., 9.0.1 in curl command) with placeholder to allow editing of this variable during the build process. Options: 1) Insert value from a bitbucket pipeline environment variable, added manually by developer 2) Parse version string from IGB code files (pom.xml or properties file?) |
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings (e.g., 9.0.1 in curl command) with placeholder to allow editing of this variable during the build process.
Options: 1) Insert value from a bitbucket pipeline environment variable, added manually by developer 2) Parse version string from IGB code files (pom.xml or properties file?) PREFERRED |
| Rank | Ranked higher |
| Assignee | Ann Loraine [ aloraine ] |
| Summary | replace IGB version strings with IGB_VERSION environment variable references | Replace IGB version strings with IGB_VERSION environment variable references |
| Summary | Replace IGB version strings with IGB_VERSION environment variable references | Get IGB version strings from POM instead of hard-coding |
| Description |
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings (e.g., 9.0.1 in curl command) with placeholder to allow editing of this variable during the build process.
Options: 1) Insert value from a bitbucket pipeline environment variable, added manually by developer 2) Parse version string from IGB code files (pom.xml or properties file?) PREFERRED |
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings with value parsed from POM.xml
|
| Labels | Beginner |
| Description |
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings with value parsed from POM.xml
|
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings with value parsed from root POM.xml version string.
In addition, change name of release build artifacts IGB-[platform]-[version].[dmg|exe|sh] where "version" is version string obtained from POM. Don't assume anything about what "version" will be. For an example, see how this is being done for Genoviz SDK build process. This will likely require understanding and editing the Install4J configuration file. *Tip*: do as much editing and testing as possible using our Dockerized build environment on an EC2 or on your own machine, not bitbucket. It will probably take less effort. This is tagged as beginner because the process and tooling are well-documented. Requires understanding how multiple systems interact. After this you will have a deeper knowledge of how we build the project. |
| Rank | Ranked higher |
| Fix Version/s | 9.0.2 Minor Release [ 10600 ] |
| Labels | Beginner | Intermediate |
| Description |
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings with value parsed from root POM.xml version string.
In addition, change name of release build artifacts IGB-[platform]-[version].[dmg|exe|sh] where "version" is version string obtained from POM. Don't assume anything about what "version" will be. For an example, see how this is being done for Genoviz SDK build process. This will likely require understanding and editing the Install4J configuration file. *Tip*: do as much editing and testing as possible using our Dockerized build environment on an EC2 or on your own machine, not bitbucket. It will probably take less effort. This is tagged as beginner because the process and tooling are well-documented. Requires understanding how multiple systems interact. After this you will have a deeper knowledge of how we build the project. |
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings with value parsed from root POM.xml version string.
In addition, change name of release build artifacts IGB-[platform]-[version].[dmg|exe|sh] where "version" is version string obtained from POM. Don't assume anything about what "version" will be. For an example, see how this is being done for Genoviz SDK build process. This will likely require understanding and editing the Install4J configuration file. *Tip*: do as much editing and testing as possible using our Dockerized build environment on an EC2 or on your own machine, not bitbucket. It will probably take less effort. This is tagged as Intermediate because the process and tooling are well-documented but requires understanding how multiple systems interact. After this you will have a deeper knowledge of how we build the project. |
| Rank | Ranked higher |
| Rank | Ranked higher |
| Sprint | Winter 2018 Sprint 2 [ 57 ] |
| Rank | Ranked higher |
| Assignee | Srishti Tiwari [ stiwari8 ] |
| Status | Open [ 1 ] | In Progress [ 3 ] |
| Rank | Ranked higher |
| Sprint | Winter 2018 Sprint 2 [ 57 ] | Winter 2018 Sprint 2, Winter 2018 Sprint 3 [ 57, 58 ] |
| Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
| Assignee | Srishti Tiwari [ stiwari8 ] | Ann Loraine [ aloraine ] |
| Assignee | Ann Loraine [ aloraine ] |
| Assignee | Ann Loraine [ aloraine ] |
| Status | Needs 1st Level Review [ 10005 ] | Reviewing [ 10301 ] |
Need to modify the curl commands so that the version 9.1.0 is not hard-coded in the script.
Suggestion: maybe can use Unix "sed" command to substitute underscore character (_) for fullstop (.) character in file name?
Nice use of mvn in get_version.sh, btw!
| Status | Reviewing [ 10301 ] | Open [ 1 ] |
| Assignee | Ann Loraine [ aloraine ] | Srishti Tiwari [ stiwari8 ] |
Question: Why do I need to login to docker hub to run the docker image?
| Status | Open [ 1 ] | In Progress [ 3 ] |
| Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
| Status | Needs 1st Level Review [ 10005 ] | Reviewing [ 10301 ] |
| Assignee | Srishti Tiwari [ stiwari8 ] | Ann Loraine [ aloraine ] |
Note that the IGB version string (with underscores replacing period (.) characters0 through the script build_igb.sh.
This affects the installers.
I don't know why we need to replace underscores with periods. Maybe there is a reason?
Please follow up:
- find out: why do we need to use underscore characters in the names of the installers. For example, can we name the Windows installer IGB-windows-x64_$version.exe?
Things to check:
- updates.xml (http://bioviz.org/igb/releases/igb-9.0.2/updates.xml) is accessed by installed IGB version to determine if a new release is available. Check if "targetMediaFileId" in the XML is used by the installer software to link deployed IGB versions to updates.
- can windows computers handle file names with multiple periods in them? For example, is foo.9.0.1.exe recognized as a program?
| Assignee | Ann Loraine [ aloraine ] | Srishti Tiwari [ stiwari8 ] |
| Status | Reviewing [ 10301 ] | Open [ 1 ] |
| Rank | Ranked higher |
| Sprint | Winter 2018 Sprint 2, Winter 2018 Sprint 3 [ 57, 58 ] | Winter 2018 Sprint 2, Winter 2018 Sprint 3, Spring 2019 Sprint 1 [ 57, 58, 59 ] |
| Rank | Ranked higher |
| Assignee | Srishti Tiwari [ stiwari8 ] | Ann Loraine [ aloraine ] |
| Sprint | Winter 2018 Sprint 2, Winter 2018 Sprint 3, Spring 2019 Sprint 1 [ 57, 58, 59 ] | Winter 2018 Sprint 2, Winter 2018 Sprint 3 [ 57, 58 ] |
| Rank | Ranked higher |
| Sprint | Winter 2018 Sprint 2, Winter 2018 Sprint 3 [ 57, 58 ] | Winter 2018 Sprint 2, Winter 2018 Sprint 3, Spring 2019 Sprint 2 [ 57, 58, 60 ] |
| Rank | Ranked higher |
| Sprint | Winter 2018 Sprint 2, Winter 2018 Sprint 3, Spring 2019 Sprint 2 [ 57, 58, 60 ] | Winter 2018 Sprint 2, Winter 2018 Sprint 3 [ 57, 58 ] |
| Rank | Ranked lower |
| Rank | Ranked higher |
| Rank | Ranked higher |
| Rank | Ranked higher |
| Assignee | Ann Loraine [ aloraine ] |
| Rank | Ranked higher |
| Sprint | Winter 2018 Sprint 2, Winter 2018 Sprint 3 [ 57, 58 ] | Winter 2018 Sprint 2, Winter 2018 Sprint 3, Summer 2019 Sprint 9 [ 57, 58, 68 ] |
| Rank | Ranked lower |
| Sprint | Winter 2018 Sprint 2, Winter 2018 Sprint 3, Summer 2019 Sprint 9 [ 57, 58, 68 ] | Winter 2018 Sprint 2, Winter 2018 Sprint 3 [ 57, 58 ] |
| Rank | Ranked higher |
| Sprint | Winter 2018 Sprint 2, Winter 2018 Sprint 3 [ 57, 58 ] | Winter 2018 Sprint 2, Winter 2018 Sprint 3, Summer 2019 Sprint 10 [ 57, 58, 69 ] |
| Rank | Ranked higher |
| Description |
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings with value parsed from root POM.xml version string.
In addition, change name of release build artifacts IGB-[platform]-[version].[dmg|exe|sh] where "version" is version string obtained from POM. Don't assume anything about what "version" will be. For an example, see how this is being done for Genoviz SDK build process. This will likely require understanding and editing the Install4J configuration file. *Tip*: do as much editing and testing as possible using our Dockerized build environment on an EC2 or on your own machine, not bitbucket. It will probably take less effort. This is tagged as Intermediate because the process and tooling are well-documented but requires understanding how multiple systems interact. After this you will have a deeper knowledge of how we build the project. |
Whenever we do a release of IGB, we have to hard-code the IGB version string.
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings with value parsed from root POM.xml version string. For an example, see how this is being done for Genoviz SDK build process. Note: the most complicated aspect of this will probably be figuring out how to create the version string used in the IGB installer names, which use underscore characters instead of periods. |
| Description |
Whenever we do a release of IGB, we have to hard-code the IGB version string.
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings with value parsed from root POM.xml version string. For an example, see how this is being done for Genoviz SDK build process. Note: the most complicated aspect of this will probably be figuring out how to create the version string used in the IGB installer names, which use underscore characters instead of periods. |
Whenever we do a release of IGB, we have to hard-code the IGB version string.
Review bitbucket-pipelines.yml file and replace hard-coded IGB version strings with value parsed from root POM.xml version string. For an example, see how this is being done for Genoviz SDK build process. Note: the most complicated aspect of this will probably be figuring out how to create the version string used in the IGB installer names, which use underscore characters instead of periods. Note: [~stiwari8] worked on this previously. The issue description previously recommend testing the build environment and process using Docker image running on a local host. See comments. |
| Comment | [ Note: This may be a two-person job. We can ask another developer to take over for the next steps as you have made a good foundation on this. ] |
| Status | Open [ 1 ] | Open [ 1 ] |
| Epic Link | IGBF-1531 [ 17617 ] |
| Story Points | 1 | 2 |
| Status | Open [ 1 ] | In Progress [ 3 ] |
| Assignee | Ann Loraine [ aloraine ] |
- using mvn help plugin to get version
- will use mvn to get last commit hash; use in jar file name for default pipeline
- should make sure this works for when not interested in building installer
| Sprint | Winter 2018 Sprint 2, Winter 2018 Sprint 3, Summer 2019 Sprint 10 [ 57, 58, 69 ] | Winter 2018 Sprint 2, Winter 2018 Sprint 3, Summer 2019 Sprint 10, Summer 2019 Sprint 11 [ 57, 58, 69, 70 ] |
| Rank | Ranked higher |
| Status | In Progress [ 3 ] | Needs Testing [ 10002 ] |
| Assignee | Ann Loraine [ aloraine ] |
May require around 5 hours effort for full testing and code review - many moving parts here.
Suggestions for how to test:
- Make an all-new fork for testing the bb pipeline build system. (Plz delete when done.)
- Configure it install repository instructions; validate that the instructions still work.
- Use your fork to check that each pipeline can run using your fork; make & push "dummy" branches to trigger each pipeline.
- Confirm that expected installers and files are copied to your Downloads section and can run.
- Read comments and instructions; check that they are understandable
In addition, we need to test that the Install4J update system is still working, since I have changed the installer names. Also, I have removed an environment variable - CODEBASE_URL - that did not seem to be used anywhere.
Suggestion for testing:
- Install 9.0.2 IGB on your system, run it, then shut it down.
- Set up a bioviz.org copy on your local or EC2, using the update XML file created by the release branch pipeline. As an example, see https://bioviz.org/igb/releases/current/ and files it contains.
- Copy the newly built installers on your bioviz copy.
- Modify your "hosts" file to "trick" your system into accessing your bioviz copy instead of the "real" bioviz.org.
- Launch IGB 9.0.2. The Install4J software will launch and try to access https://bioviz.org/igb/releases/current/updates.xml (the new one you built above)
- When it reads the new updates.xml, it will detect there is a new version of IGB available - 9.1.0 - and it will ask you (the user) if you want to update your IGB. (Say yes.)
- Download and run the new IGB.
Something to check: I am not sure why, but previously we had an environment variable:
- CODE_BASE_URL https://bioviz.org/igb/releases/current
that did not appear to be used anywhere. I removed it. However, I am worried that this environment variable was needed to tell installer software Install4J where to get notification that a new version was available.
To test this, increment the IGB version from 9.1.0 to 9.1.1 – on your fork. Deploy the newly created updates.xml and installers on your fake bioviz.
Check that your newly installed IGB version 9.1.0 gets updated to 9.1.1 as it should.
| Assignee | Srishti Tiwari [ stiwari8 ] |
| Status | Needs Testing [ 10002 ] | Testing In Progress [ 10003 ] |
Install4j update system is working correctly. Marking this issue as closed.
| Resolution | Done [ 10000 ] | |
| Status | Testing In Progress [ 10003 ] | Closed [ 6 ] |
| Workflow | Loraine Lab Workflow [ 17872 ] | Fall 2019 Workflow Update [ 19824 ] |
| Workflow | Fall 2019 Workflow Update [ 19824 ] | Revised Fall 2019 Workflow Update [ 21943 ] |
To test this issue :
1. Install Docker on your machine; start Docker daemon
2. Open bitbucket-pipelines.yml file and notice the docker image name: ( lorainelab/igb-maven-install4j:jre-1.8.0_191 ). Pull this docker image using command docker pull lorainelab/igb-maven-install4j:jre-1.8.0_191
3. docker login
4. clone the repository
5. Open build_igb
6. Replace the bitbucket pipeline variables with actual values
7. Run each statement one by one on the docker terminal.