How to deploy files to service.unece.org

Table of Contants

This how-to describes process of getting files from your local PC to service.unece.org using Repositories and Pipelines. Should be reffered to typically when a new version of UN/EDIFACT, UN/LOCODE or other deliverable hosted on service.unece.org is produced and needs to be published.

Diagram

Simplified diagram of the whole process:

Resources

Repository Web interface

• UNECE Bitbucket - https://bitbucket.unece.org
• Trade Repositories - https://bitbucket.unece.org/projects/TRADE
  • UN/CEFACT (BRS, CCL, Codelists, Recommendations, RSM, XML Schemas, etc. ) - https://bitbucket.unece.org/projects/TRADE/repos/uncefactservice/browse
  • UN/LOCODE - https://bitbucket.unece.org/projects/TRADE/repos/locodeservice/browse
  • UNTDID (UN/EDIFACT) - https://bitbucket.unece.org/projects/TRADE/repos/untdidservice/browse

Repository GUI

• Sourcetree - https://www.sourcetreeapp.com/ or local SourceTreeSetup-2.6.9.exe
• Prerequisit to install Sourcetree is MS .NET Framework 7.4.1
  • Web Installer - https://www.microsoft.com/en-us/download/details.aspx?id=56115 or local NDP471-KB4033344-Web.exe
  • Offline Installer - https://www.microsoft.com/en-us/download/details.aspx?id=56116

Pipeline Web interface

• UNECE Bamboo - https://bamboo.unece.org
• Trade Pipelines - https://bamboo.unece.org/browse/TRADE
  • UN/CEFACT Pipeline - https://bamboo.unece.org/browse/TRADE-SU2
  • UN/LOCODE Pipeline - https://bamboo.unece.org/browse/TRADE-SL
  • UNTDID (UN/EDIFACT) Pipeline - https://bamboo.unece.org/browse/TRADE-SU

Working with Git

Official Sourcetree documentation

• Install Sourcetree https://confluence.atlassian.com/get-started-with-sourcetree/install-sourcetree-847359094.html
• Connect your Bitbucket or Github account https://confluence.atlassian.com/get-started-with-sourcetree/connect-your-bitbucket-or-github-account-847359096.html
• Clone a remote repository https://confluence.atlassian.com/get-started-with-sourcetree/clone-a-remote-repository-847359098.html
• Commit and push a change (Git) https://confluence.atlassian.com/get-started-with-sourcetree/commit-and-push-a-change-git-847359114.html
• Pull changes from a remote repository (Git) https://confluence.atlassian.com/get-started-with-sourcetree/pull-changes-from-a-remote-repository-git-847359111.html

Step-by-step guide

Installing and Configuring tools

Sourcetree Initial configuration 

• Download and install Sourcetree, if needed install also MS .NET Framework 7.4.1, as this requires Administrator privilegies, ask ISU for assistance
• After Installation run Sourcetree application

• As part of initial execution, configure Sourcetree - useraccount and tools

  1. Login to remote Repository 
     1. Image RemovedImage Added
  2. Authenticate user (using Windows / Active Directory credentials)
     1. 
  3. If Credentials are correct, you should see confirmation
     1. Image RemovedImage Added
  4. Select modules for installation (we need only Git)
     1. Image RemovedImage Added
  5. Module installation - progress
     1. Image RemovedImage Added
  6. Module installation - confirmation
     1. Image RemovedImage Added
  7. SSH key configuration (can be skipped)
     1. 

Cloning Repository

• After Initial setup we configure and clone repositories
  
  1. Add a new repository
     1. Image RemovedImage Added
  2. On remote server, click "Clone in SourceTree" for easy configuration, or click on "Clone" and copy repository link (for Git repositories the link ends with .git)
     1. Image RemovedImage Added
  3. Review Cloning configuration, select local folder where files shoud be stored
     1. Image RemovedImage Added
  4. Run Clone and wait for process to finish
     1. Image RemovedImage Added
     2. Image RemovedImage Added
     3. Image RemovedImage Added

Making a change in files

• Local repo without a change, after Initial Cloning we have a files in Local Repo the same state as they appear on Remote Repo (local repo is in sync with the remote repo)

  • Image RemovedImage Added
• Local Repository in windows explorer
  • Image RemovedImage Added
• New files (selected) to be transferred to local repo in windows explorer
  • Image RemovedImage Added

• Transfer to local repo Overwrite prompt (if updating files to a new version)

  • 
• Transfer to Local repo running
  
  • 
    
    
• We have a new files (we updated the current files) in our local repo (this is considedred as a change, another type of change is adding and removing files/folders) 
  1. New files in local repo - see file status and commit log
     1. Image RemovedImage Added
     2. Image RemovedImage Added
  2. Differences - after selecting the file we can see details of Changes 
     1. Image RemovedImage Added
     2. Image RemovedImage Added
     3. Image RemovedImage Added
  3. Staging files - by selecting files clicking on "Stage Selected", selected files are staged and moved to Staged file window
     1. Image RemovedImage Added
  4. Adding commit message - we add commit message explaining nature of the change
     1. Image RemovedImage Added
  5. User info for trhe first commit - we are asked to provide email (full name should be automatically populated)
     1. Image Added
     2. Image RemovedImage Added
  6. Commit is linked to user account and we can click on "Commit" button to execute a commit
     1. Image RemovedImage Added
  7. After commit is executed, changes are prepared to be Pushed to remote repository, Push will became available
     1. Image RemovedImage Added
     2. Image RemovedImage Added
  8. Push - after clicking on "Push" button, we are asked to select branch, in this simple example we are staying in only one branch - master
     1. Image RemovedImage Added
  9. Push running, after clicking on Push button from branch selection, Commits (containing changes) are pushed to Remote Repository
     1. Image RemovedImage Added
  10. Push completed, we can see our changes in Graph view on Log/History tab
      1. Image RemovedImage Added
  11. Bitbucket - on Remote repo - Commits - we can also see our Commits
      1. Image RemovedImage Added
  12. Bitbucket - on Remote repo - Sources - we can also see each individual file together with commit message
      1. Image RemovedImage Added

Running Pipelines

• Go to Trade Division pipelines - https://bamboo.unece.org/browse/TRADE
  • 

  1. Select desired Pipeline (in our case, as we are deploying new LOCODE Directory version - Service LOCODE)

     1. 
  2. Select job (plan) to run
     1. 

From Local Repository to Stage

1. Deploy to Stage - Run plan
   1. 

2. Deploy to Stage - running

   1. 

3. Deploy to Stage - completed

   1. 

4. Changes appear on Stage for validation (service-qa.unece.org) 

   1. We can see changes on Page
      1. 
   2. And in it's Source
      1. 

From Stage to Prod

1. Deploy to production - run option 1 from the left menu
   1. 
2. Deploy to production - run option 2 from the top menu
   1. 
3. Confirmation of "Deploy to PRD" run
   1. 
4. Deploy to production - running
   1. 
5. Deploy to production - completed
   1. 
6. Changes appear on Production (service.unece.org) in pages
   1. 
7. Changes appear on Production (service.unece.org) - in it's sources
   1. 
8. Link files to Production
   1. in our example https://service.unece.org/trade/locode*
   2. https://service.unece.org/trade/locode/af.htm
   3. https://service.unece.org/trade/locode/ax.htm
   4. https://service.unece.org/trade/locode/ae.htm
   5. Etc. ....