Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Refined/clarified/and elaborated on steps throughout this guide


Info
titleNote:

Certain steps are skippable; as such, they are not mentioned in the Tl;dr version. Reference the detailed steps to see them.

Tl;dr

Jira

  •  Add  For New or Existing Projects
    1.  Create a ticket for the project / requested changes for a project
    2.  Move ticket from "Backlog" to "In Progress" workflow stage
    3.  When done, notify customer / Move ticket to "Under Review"
    4.  Log work & add a closing comment with
    details such as confirmation from customer date/time (optional: attach email from customer, giving the confirmation),
  •  Complete Stash steps and Move the ticket over to the "DONE" column

Stash

  •  For new projects
    1. pertinent details (e.g. go-live approved by name/date/time etc.)


Stash

  •  For New Projects:
    1.  Create a new repository in FNF project
    2.  Clone repository to local (using Sourcetree)
    3.  Add the nitro file from Leap TEST environment
    4.  Commit and push to master (from local to remote),
      •  When committing, include the Jira ticket, by using a string "JIRA <TICKET>" (example: "JIRA FEB-530")
     For existing projects: Do the Steps 2 - 4
    1. branch,
    2.  Create a tag and notify Jason Card  for it to be released to PROD
  •  For Existing Projects:
    •  Do Steps 3 - 5, above


Confluence

...

  •  For New Projects:
    1.  Add a project requirements page

...

  •  For new projects: Update
    1.  Add all the pertinent information related to this project
    2.  When ready to go live, update the Document Properties box
    : "Document Status" at the top and
    1. and and any other sections
    (such
    1. as
    Pre Go-Live, etc,) as
    1. necessary
  •  For existing projectsExisting Projects:
    1.  Update the project's requirements page
      1.  Update the "Post Production Enhancement List" section
    2.  
    "Description" to capture enhancement(s) at high-level; provide a link: if you have a detailed documentation page (where this set of enhancements are captured in detail)
  •  After receiving confirmation/notification for Stash step #18 (that the tag has been deployed in PROD)
    •  Update Version (in PROD) property (Document Properties box) with the latest version

Jira

Update the ticket

  1.  Provide the following details in comments: Who approved the go-live and when.
    1.  If possible/you'd like to, attach the email confirmation to the comments
  2.  AFTER completing the Stash steps: Move the ticket from "UNDER REVIEW" to "DONE" column; ensure that the ticket's workflow status is "DONE" and not "CANCELLED"
  3. Notify Jason Card that the "Tag" has been created (Stash step #18)

Stash

...

    1. After the changes have gone live:
      1.  Add release date to the "Post Production Enhancement List" section


Customer Notification

  •  For New or Existing Projects: 
    1.  Copy links for Form(s) and View Responses page from Leap PROD environment
    2.  Notify customer/team that the latest changes have gone live and provide the links


...


Anchor
DetailedSteps
DetailedSteps

Info
titleNote:

Skippable steps are indicated by "(Optional)". You may choose to skip these steps, depending on your work-style — Use your best judgement!

  •  The steps outlined for Jira, Stash, and Confluence SDLC tools are not in a strict order
    •  Example: Do Jira Step 4 after Step 6 etc.
  •  Even the SDLC tools can be done in an order that suits your work style
    •  Example: Doing confluence steps first documenting the customer request, and then Stash, and finally Jira, etc.

Jira


Tip
titleTip

It is prudent to do these steps throughout  the life-cycle of the ticket (vs. doing them when closing the ticket), as it helps with accurately logging the work / time spent / updates from the customer with respect to changes in the scope of (intial) requested changes etc,


For New or Existing Projects

Step #Description
1

If new project:

  •  Create a ticket in Jira for the project if one does not exist


If existing project:

  •  Create a ticket in Jira for the requested changes to a project


2

(Optional) Log the estimated effort


3

If the ticket is in the "Backlog", move it to "In Progress" when you start working on the changes


4

(Optional) If existing project:

  • Link to the Project's parent ticket (v1.0) and provide a comment as to why you are linking to it...
Info
titleFYI

I usually do a "relates to" linking between Parent and post go-live enhancements


Image AddedImage Added
Image Added


5

(Optional) As you progress, through the requested change(s)—

a. Add comments as necessary

b. Log work / time spent

Image AddedImage Added
Image Added


6

(Optional) If scope change occurs (i.e. additional changes are requested by the customer), you may create a Smart Checklist. Markdown syntax is used for adding items and it is pretty simple and straight-forward.

Info
titleNote

Normally, the proper way to handle scope change would be to create sub-tasks — i.e. child tickets.

However, for FEB tickets it has been recommended to not do sub-tasks (as it "messes-up" (or was it "fudges" Thinking Face on Google Android 10.0 March 2020 Feature DropImage Added) the reporting of Michael Oatley )

Image Added


7

When all requested changes are complete, notify customer and move the ticket into "Under Review" workflow stage

Image Added


8

Upon receiving confirmation from the customer that all changes have been tested, verified, and confirmed, provide the following details in comments:

a. Who approved the go-live and when.

i. (Optional) Attach the confirmation email from customer to the comments

b. Log work / time spent



Stash

Anchor
newProject
newProject

Brand New Project

...

Clone Add 2 ---- this folder 2Sourcetree will notice the and list it
Image Removed
  • Select either "Stage All" or "Stage Selected", depending on your circumstance
  • Under comments, follow the following format (without quotes):
    "JIRA XXX-###
    YOUR COMMENTS"
    " (where XXX is the project key, in Jira and ### is the ticket numberNext, create a tag, by clicking
  • Next, make sure you select the "Push changes immediately to..." checkbox
  • Finally, hit the "Commit" button.

    Example of Steps 9 - 11:

    Image Removed

  • Image Removed blue line Give it an appropriate name; generally, Image Removed (Image RemovedNotify that the tag
    Step #Description
    1

    Login to stash: https://stash.uconn.edu/


    2

    Navigate to FEB Nitro Files (FNF) project


    3

    Provided you have the necessary privileges, click on the "Create repository" button, top-right

    Image Modified


    4

    Provide an appropriate name and then click on the "Create repository" button

    Image Modified


    5

     Clone repository to local — this is your local repository

    Tip
    titleTip

    Establish clean directory structure for all your Leap apps; directory within this structure is where you will create a local repository 


    a. Create a project directory for this Leap application

    b. Use git/bash command:

    Make sure you are inside the project folder of where you want to clone and then execute the following command:

    Code Block
    languagebash
    themeRDark
    titleClone Remote Repository
    linenumberstrue
    git clone REPOSITORY_URL

    Image Modified

    6

    Open up Sourcetree software


    7
     Add a new repository, by clicking on the "+" at the top:

    Image Modified

    a. Click on Add at the top:

    Image Modified

    b. Click on "Browse"

    Image Modified

    c. Navigate to where you cloned locally (Step

    5.a., above)

    d. And click on "Select Folder"

    DO NOT click on the .git folder... merely ensure that the folder you select has a .git folder (this is a hidden folder — so you might not see it, based on your settings), as shown below

    Image Modified

    e. Finally, click "Add"

    Image Modified

    Anchor
    Continue from here
    Continue from here



    8

    Go to Leap TEST environment and export the project (if you have not done it already) and save it locally

    Info
    titleHeads-up!

    Unless you have been told otherwise: Make sure that the "Include submission data?" checkbox is  not checked!


    9

    Locate the *.nitro_s file that you downloaded from Leap TEST environment and move it to

    the directory of your project's local repository (same folder as

    5.a., above)


    10

     Sourcetree automatically detects a change in

    your local repository

    ; it's time to stage your project's nitro file — Reference the screenshot below for steps 10.a & 10.b:

    a. Your project's nitro file will be listed under "Unstaged files" section



    b. Click on Image Added


    Image Added

    Info
    titleNote:

    You should only see your project's nitro file... if you see more than one file, reach out to our Leap group and troubleshoot as to why that is the case


    11


     Select "File Status" tab (if it is not selected)Image Added


    12

     Committing to remote repository — Reference the screenshot below for steps 12.a — 12.c:
      Image Added


    a. Under comments, use the following format — the first comment line & its format is mandatory!

    Code Block
    languagetext
    themeRDark
    linenumberstrue
    JIRA XXX-###
    YOUR COMMENTS

    (where XXX-### is the Jira ticket; you can provide your comments after that)

    Tip
    titleTip

    If you have a prior commit, you may click on the Image Added icon and select an applicable comment. If you select a comment from history, be sure to change the ticket number (and the comment, if applicable)!


    b. Click on Image Added

    c. Click on the Image Added button

    13
    Create a tag

     a. Click on "master" under "BRANCHES" on the left; notice that middle pane

    Image Added

     b. Right-click on the

    commit that you did in (Step 12, above) and select "Tag..."


    Image Added

    c. In the resulting dialog box, under "Add Tag" tab

    i. Provide a name for the tag (this convention should work: "NAME_OF_REPO_v#.#"

    , where #.# is your version number e.g. 1.0, 1.1, etc.)

    ii. Select/check the Image Added checkbox

    iii. Click the Image Added button

    Image Added


    14

     Notify Jason Card that the tag "TAG_NAME" (from #13.c.i) has been created and it's ready to go live.

    Start from step 5, on the left.

    Confluence


    Here's my notification template... feel free to use it, if it helps!

    Info
    titleNote:

    Change the  [PLACEHOLDERS] and in order to ensure the accuracy: the verbiage, as necessary!


    TemplateExample

    [SALUTATION]


    At your earliest convenience / release-to-prod window, please release the following tag to PROD.

    [MyTagName_v#.#]

    Details:

    The new set of changes requested by  [DEPARTMENT_NAME] for their  [LEAP_APPLICATION_NAME] form have been addressed.

    It has gone through UAT and the customer has confirmed & approved the changes and has requested for it to go live!

    All Confluence, Jira, & Stash steps have been completed.


    [CLOSING/SIGNATURE]

    Hello Jason,

    At your earliest convenience / release-to-prod window, please release the following tag to PROD.

    TaxAndCompliance-ForeignNationalInformation_v1.1

    Details:

    The new set of changes requested by the Tax and Compliance Department for their Foreign National Information form have been addressed.

    It has gone through UAT and the customer has confirmed & approved the changes and has requested for it to go live!

    All Confluence, Jira, & Stash steps have been completed.

    Best,

    Rush


    Anchor
    existingProject
    existingProject

    Existing Project

    Step #Description
    1

    On local machine, navigate to the project's directory where you have established your local repository

    Info
    titleNote:

    You should only see the .git folder and the previously exported nitro file:

    Image Added


    2Delete the nitro_s file from this directory
    3Continue from Step 8 of "Brand New Project"


    Confluence

    For a Project's Initial Release

    Step #Description
    1

    If the project requirements page does not have a

    ...

    Pre Go-Live Log section, add it

    ...

    :

    Pre Go-Live

    ...

    Log

    Go-Live DateDate of Last Deploy in TESTCustomer/Designee Sign-off & Date/TimeVersionDeveloperJIRA TicketRelease to PROD Date/TimeReleased By





    @DEVELOPER NAME

    •  JavaScript files: using minified versions?
    •  Confirm Security/Access Control (as reflected on THIS page)
    •  Update Jira Ticket
    •  Stash component
    •  Queued for Go-Live! / Notify Jason Card
    •  Update project's requirements page on Confluence
    •  Notify customer/team post deployment with relevant link(s)












    2Follow/go through the developer's checklist, as listed within the Pre Go-Live Log
    3

    Update the  Document Properties  box

    • "Document Status" should state 
      Status
      colourBlue
      titlePRODUCTION
    4

    If you have done detailed documentation for your project, add a link to it right after the Document Properties box by:

    a. Adding an Info macro, with the following verbiage

    This is a high-level requirements document ONLY. If you are maintaining this application, are performing a maintenance, or just interested in the details, please reference the detailed documentation.

    b. Format the text as: Heading 2

    c. Add a link back to the high-level requirements document on your detailed documentation page, with the following verbiage

    This is a detailed documentation for this project. If you would like to get a birds-eye view (Tl;dr) version, please reference the high-level documentation.


    d. Optional: if you have Table of Contents (ToC) macro on either the Detailed Documentation page or the High-Level Requirements Document page, edit the ToC macro and add the following RegEx so that it is excluded from it:

    Code Block
    languagetext
    themeRDark
    This is a detailed.*


    High-Level Requirements PageDetailed Documentation Page
    Image AddedImage Added




    5

    Update any other details as necessary

    6

    Verify & confirm the accuracy of:

    • User Interaction & Design Diagram
    • Security / Access Control


    For a Project's Subsequent Releases

    Step #Description
    1

    Update the "Post Production Enhancement List" section—

    a. List the enhancements made at a high level

    i. (Optional) Provide a link to detailed documentation page where these enhancements are captured in detail

    b. Add customer name with Day/Date/Time of when it was approved to go live

    i. (Optional) Include the confirmation email

    c. Link the Jira issue

    d. Provide information for the other columns, which are self-explanatory


    Tip
    titleTip

    You may start adding information to the Post Production Enhancement List log, from the day you receive a request for changes from the customer, and then update the log over time...

    I do this myself and shown below are several screenshots of this log over time...


    Image Added


    Image Added


    Image Added


    Image Added




    Customer Notification

    Step #Description
    1

    Login into Leap PROD environment: https://hclleap-prod2.its.uconn.edu/apps/login/org/index.html


    2

    Search for your project

    Image Added


    3

    Copy PROD links:

    a. Click on "Launch" and copy the link from the resulting page

    b. Click on "View Responses" and copy the link from the resulting page


    Image Added

    Info
    titleNote:

    Click on the down arrow for "Launch", if your project has multiple forms, in order to copy each form's links


    4

    Notify customer/team that the latest changes have gone live and provide the links


    Here's my notification template... feel free to use it, if it helps!

    Info
    titleNote:

    Change the  [PLACEHOLDERS] and in order to ensure the accuracy: the verbiage, as necessary!


    TemplateExample

    [SALUTATION]


    The form has gone live and here are the two links, as promised:

    1.  Live form:  [FORM_LINK]
    2.  View Responses: [VIEW_RESPONSES_LINK]

    If you have any questions or if I can be of further assistance, please do not hesitate to reach out.

    [CLOSING/SIGNATURE]

    Good afternoon [Name],

    The form has gone live and here are the two links, as promised:

    1.  Live form: [FORM_LINK]
    2.  View Responses: [VIEW_RESPONSES_LINK]

    If you have any questions or if I can be of further assistance, please do not hesitate to reach out.

    Best,
    Rush