Access-Boston Config

Repo: https://github.com/CityOfBoston/access-boston-config

This repository exists to manage changes to the "front end" side of the Access Boston website without the need of a developer. The changes that can be made are for: application icons, application names, application links, and application access/assigned security group. The changes will be made by editing the "config files" for each of the website environments (i.e. development, test, production). The changes need to be made on each environment separately. The following are step-by-step instructions on how to make these edits.

Once these edits are made and saved there will be an automated notification to the digital team. The digital team will initiate the site to be 're-built'. The changes should appear on the Access Boston site within 30-60 minutes.

It is encouraged to make these changes Monday-Firday, 9 a.m.-5 p.m., if possible, to ensure that if something goes run that there are available staff to help resolve.

Edit and Deploy Process

1. From the repository landing page, edit the config file for the environment (dev/test/prod) you want to change, by going from the 'src' and the 'config' folder; the click on the folder for the environment you want to edit.

   • 

2. Click on the 'apps.yaml' file, from the details view click the 'Edit this File' icon.

   Adding new links require 3 of the following fields:

   • title
   • url
   • *groups
   • *icon

   *Icon is require for links in the 'Apps' section, at the top of the file.

   *Groups is a list of groups of people with access that application. The formatting should follow this style:

   

3. When you're done making changes, click on the 'Commit Changes' button on the top right corner. This will open a pop-up modal; provide a name and description for the changes made.

4. In pop-up modal select the "Create a new Branch for this commit" radio button

5. When you're done, hit the "Commit Changes" button

6. Give the new branch for your work a name.

7. Hit the "Propose Changes" button; this will take you to another screen where you will see a preview of the "Pull Request" that will be created.

8. Hit the "Create Pull Request" button. This will create the PR and you will be take to its page.

9. On the PR page tag a reviewer to approve your changes. After you'll be able to "Merge" your changes. After mergin a github action for (Force) Push Changes to deploy-branches. This will update the corresponding [deploy-dev|test|prod] branch to match the master branch.

10. Go to the Deploy AB Configs to Amazon S3 Github Actions, click on the Run workflow to select what branch to run this action on

11. Select the branch your previous commit targeted and clic Run workflow

12. Wait for the workflow to run, it will show a green circular check mark if the it passed, and a red circular x if it failed

13. Go to the AWS Console and update the ECS instance you want to update with this config change. This will create a new instance of the service and spin down the previous ones once its stable

14. DONE