Details

    • Type: Documentation
    • Status: Closed (View Workflow)
    • Priority: Minor
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None

      Description

      In Chapter 2, Update the Azul web site link to current version of java that is being used in code.

      In Chapter 3, it is mentioned to run the default pipeline after enabling Bitbucket Pipelines for testing purposes. However, the default pipeline is no longer in use. Instead custom:manual-build is being used.

      Update the documentation by replacing references to the default pipeline with custom: manual-build

        Attachments

          Activity

          Hide
          uchinta Udaya Chinta added a comment -

          Worked with Nowlan Freese to update the canvas course.

          1. Updated the screenshot in canvas course to use custom:manual-build and all the reference related to default build is updated with custom:manual-build.
          2. https://jira.bioviz.org/browse/IGBF-1764 - Updated the description in this jira to run main branch instead of master branch. Since main branch has the updated code.

          To Do:
          The IGBF-* branches and the default pipelines in the bitbucket-pipelines.yml file are currently not in use. I will update the documentation related to branch configurations once I clarify doubts regarding the removal of the default pipeline with Jaya Sravani Sirigineedi.

          Show
          uchinta Udaya Chinta added a comment - Worked with Nowlan Freese to update the canvas course. Updated the screenshot in canvas course to use custom:manual-build and all the reference related to default build is updated with custom:manual-build. https://jira.bioviz.org/browse/IGBF-1764 - Updated the description in this jira to run main branch instead of master branch. Since main branch has the updated code. To Do: The IGBF-* branches and the default pipelines in the bitbucket-pipelines.yml file are currently not in use. I will update the documentation related to branch configurations once I clarify doubts regarding the removal of the default pipeline with Jaya Sravani Sirigineedi .
          Hide
          uchinta Udaya Chinta added a comment - - edited

          I worked with Jaya Sravani Sirigineedi regarding Bitbucket pipelines and gathered the required information. Based on this, I suggest updating the text as follows:

          Present text:
          Within bitbucket, when you push a change to a branch with a name that matches one of the branch-specific patterns, then the pipeline for that branch runs. For example, if you push a branch to your fork that has branch name matching "IGBF-*", the corresponding "IGBF-" branch pipeline will run. In this case, the pipeline compiles IGB and also packages IGB into operating-specific installers using Install4J. Likewise, branches that contain "release-" in the name will trigger a different pipeline to that builds installers will run. If the affected branch name does not match either of these two patterns, the default pipeline will run, which simply compiles IGB but does not build installers.

          Proposed text:
          Within bitbucket, when you push a change to a branch with a name that matches one of the branch-specific patterns, then the pipeline for that branch runs. For example, if you push a branch to your fork that has branch name matching "release-*", the corresponding "release-" branch pipeline will run. In this case, the pipeline compiles IGB and also packages IGB into operating-specific installers using Install4J. If the affected branch name does not match any branch name specified in bitbucket-pipelines.yml, the pipeline can be triggered manually using one of the available custom pipelines.

          The above text needs to be updated in the IGBEE Canvas Course: Module 3 - Set Up Bitbucket Pipeline.

          Ann Loraine and Paige Kulzer please review the proposed text and let me know if any changes are required.
          Since I do not have credentials to update the canvas course, I request to modify the text in the canvas course.

          Show
          uchinta Udaya Chinta added a comment - - edited I worked with Jaya Sravani Sirigineedi regarding Bitbucket pipelines and gathered the required information. Based on this, I suggest updating the text as follows: Present text: Within bitbucket, when you push a change to a branch with a name that matches one of the branch-specific patterns, then the pipeline for that branch runs. For example, if you push a branch to your fork that has branch name matching "IGBF-*", the corresponding "IGBF-" branch pipeline will run. In this case, the pipeline compiles IGB and also packages IGB into operating-specific installers using Install4J. Likewise, branches that contain "release-" in the name will trigger a different pipeline to that builds installers will run. If the affected branch name does not match either of these two patterns, the default pipeline will run, which simply compiles IGB but does not build installers. Proposed text: Within bitbucket, when you push a change to a branch with a name that matches one of the branch-specific patterns, then the pipeline for that branch runs. For example, if you push a branch to your fork that has branch name matching "release-*", the corresponding "release-" branch pipeline will run. In this case, the pipeline compiles IGB and also packages IGB into operating-specific installers using Install4J. If the affected branch name does not match any branch name specified in bitbucket-pipelines.yml, the pipeline can be triggered manually using one of the available custom pipelines. The above text needs to be updated in the IGBEE Canvas Course: Module 3 - Set Up Bitbucket Pipeline. Ann Loraine and Paige Kulzer please review the proposed text and let me know if any changes are required. Since I do not have credentials to update the canvas course, I request to modify the text in the canvas course.
          Hide
          jsirigin Jaya Sravani Sirigineedi added a comment -

          The proposed text looks good as per the latest changes in the bitbucket-pipelines.yml, Udaya Chinta, you can go ahead and change the canvas course.

          Show
          jsirigin Jaya Sravani Sirigineedi added a comment - The proposed text looks good as per the latest changes in the bitbucket-pipelines.yml, Udaya Chinta , you can go ahead and change the canvas course.
          Hide
          pbhatia1 Pranav Bhatia added a comment - - edited

          Recommendations for updating canvas course IGB100 as discussed with Sravani
          In the *Set up your local development environment *page please update the below -

          When we click on the hyperlink for* 'Azul Web site' *it is redirecting to Java 8 version page, please change the hyperlink so that the user gets redirected to Java 21 page.

          Link to version 21 - https://www.azul.com/downloads/?version=java-21-lts&package=jdk-fx#zulu

          Show
          pbhatia1 Pranav Bhatia added a comment - - edited Recommendations for updating canvas course IGB100 as discussed with Sravani In the *Set up your local development environment *page please update the below - When we click on the hyperlink for* 'Azul Web site' *it is redirecting to Java 8 version page, please change the hyperlink so that the user gets redirected to Java 21 page. Link to version 21 - https://www.azul.com/downloads/?version=java-21-lts&package=jdk-fx#zulu
          Hide
          uchinta Udaya Chinta added a comment -

          Thanks, Pranav Bhatia, for identifying that the link was redirecting to an older version of Java.
          I have updated the Canvas course.

          Below are the instructions to verify the changes:

          1. Log in to the OSGi Canvas course at https://canvas.instructure.com/courses/1164217.
          2. Navigate to Modules -> 2. Setting up -> Set up your local environment.
            1.Go to the 3rd point under Clone your fork to your local computer.
            2.When you click on the Azul Web Site link, it should redirect you to the Java 21 downloads page.
          3. Navigate to Modules -> 3. DevOps -> Set up Bitbucket Pipelines.
            1.Under "Regarding branch and custom pipelines (core IGB team only):" verify if the updated text is reflected as proposed.
          Show
          uchinta Udaya Chinta added a comment - Thanks, Pranav Bhatia , for identifying that the link was redirecting to an older version of Java. I have updated the Canvas course. Below are the instructions to verify the changes: Log in to the OSGi Canvas course at https://canvas.instructure.com/courses/1164217 . Navigate to Modules -> 2. Setting up -> Set up your local environment. 1.Go to the 3rd point under Clone your fork to your local computer. 2.When you click on the Azul Web Site link, it should redirect you to the Java 21 downloads page. Navigate to Modules -> 3. DevOps -> Set up Bitbucket Pipelines. 1.Under "Regarding branch and custom pipelines (core IGB team only):" verify if the updated text is reflected as proposed.
          Hide
          sjagarap saideepthi jagarapu added a comment -

          Proposed changes are reflected in canvas course documentation, hence moving this to done state.

          Show
          sjagarap saideepthi jagarapu added a comment - Proposed changes are reflected in canvas course documentation, hence moving this to done state.

            People

            • Assignee:
              uchinta Udaya Chinta
              Reporter:
              uchinta Udaya Chinta
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: