Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/1545 (part 2) Setup deployment for live comms site #1548

Merged
merged 23 commits into from
Jan 28, 2022

Conversation

riatzukiza
Copy link

@riatzukiza riatzukiza commented Jan 14, 2022

Summary of Changes

blocked until #1555 has been merged

In order to actually deploy the site, we needed to set up a cloud foundry deployment script, a manifest file, and make changes to the circle CI config. There are also some small adjustments that have to be made to the HTML files in order for them to find resources.

Pull request closes #1545
Acceptance criteria as stated in the issue

How to Test

List the steps to test the PR
These steps are generic, please adjust as necessary.

cd tdrs-frontend && docker-compose -f docker-compose.yml -f docker-compose.local.yml up -d
cd tdrs-backend && docker-compose -f docker-compose.yml -f docker-compose.local.yml up -d 
  1. Open http://localhost:3000/ and sign in.
  2. Proceed with functional tests as described herein.
  3. Test steps should be captured in the demo GIF(s) and/or screenshots below.

Demo GIF(s) and screenshots for testing procedure

Deliverable 1: Accepted Features

Performance Standard(s): At the beginning of each sprint, the Product Owner and development team will collaborate to define a set of user stories to be completed during the sprint. Acceptance criteria for each story will also be defined. The development team will deliver code and functionality to satisfy these user stories.

Acceptable Quality Level: Delivered code meets the acceptance criteria for each user story. Incomplete stories will be assessed and considered for inclusion in the next sprint.

  • Look up the acceptance criteria in the related issue; paste ACs below in checklist format.
  • Check against the criteria:
    • The existing live comms repo is moved from Miles' repo to an existing project repo (TANF-app)
    • Design is still able to maintain the live comms site as they do on its current GitHub Pages hosting (e.g. no/minimal new code introduced to make it work, control over dependencies)
  • Hosted via cloudfoundry cloud.gov route
  • Testing Checklist has been run and all tests pass
  • README is updated, if necessary
    As Product Owner, @lfrohlich will decide if ACs are met.

Deliverable 2: Tested Code

Performance Standard(s): Code delivered under the order must have substantial test code coverage. Version-controlled HHS GitHub repository of code that comprises products that will remain in the government domain.

Acceptable Quality Level: Minimum of 90% test coverage of all code. All areas of code are meaningfully tested.

  • Are all areas of code introduced in this PR meaningfully tested?
    • If this PR introduces backend code changes, are they meaningfully tested?
    • If this PR introduces frontend code changes, are they meaningfully tested?
  • Are code coverage minimums met?

Deliverable 3: Properly Styled Code

Performance Standard(s): GSA 18F Front- End Guide

Acceptable Quality Level: 0 linting errors and 0 warnings

  • Are backend code style checks passing on CircleCI?
  • Are frontend code style checks passing on CircleCI?
  • Does this PR change any linting or CI settings?

Deliverable 4: Accessible

Performance Standard(s): Web Content Accessibility Guidelines 2.1 AA standards

Acceptable Quality Level: 0 errors reported using an automated scanner and 0 errors reported in manual testing

  • Does this PR complete the epic?
  • Are links included to any other gov-approved PRs associated with epic?
  • Does PR include documentation for Raft's a11y review?
  • Did automated and manual testing with @iamjolly and @ttran-hub using Accessibility Insights reveal any errors introduced in this PR?

Deliverable 5: Deployed

Performance Standard(s): Code must successfully build and deploy into the staging environment.

Acceptable Quality Level: Successful deployment by assigning a 'Deploy with CircleCI - {env}' label

  • Was the code successfully deployed via automated CircleCI process to development on Cloud.gov?

Deliverable 6: Documented

Performance Standard(s): Summary of user stories completed every two weeks. All dependencies are listed and the licenses are documented. Major functionality in the software/source code is documented, including system diagram. Individual methods are documented inline in a format that permits the use of tools such as JSDoc. All non-inherited 800-53 system security controls are documented in the Open Control or OSCAL format and HHS Section 508 Product Assessment Template (PAT) are updated as appropriate.

Acceptable Quality Level: Combination of manual review and automated testing, if available

  • If this PR introduces backend code, is that code documented both inline and overall?
  • If this PR introduces frontend code, is that code documented both inline and overall?
  • If this PR introduces dependencies, are their licenses documented?

Deliverable 7: Secure

Performance Standard(s): Open Web Application Security Project (OWASP) Application Security Verification Standard 3.0

Acceptable Quality Level: Code submitted must be free of medium- and high-level static and dynamic security vulnerabilities

  • Does the OWASP Scan pass on CircleCI?
  • Do manual code review and manual testing detect any security issues?

Deliverable 8: Context

  • Performance Standard(s): Code must be understandable and contextualized for the reviewers possess the knowledge and background necessary for analysis and constructive criticism to take place.
  • Acceptable Quality Level: Code submitted in the pull request has context.*
  • Does this pull request contain sufficient inline comments providing relevant context for code snippets?
  • Is the code understandable and lucid?
  • Does this pull request provide background for why coding decisions were made?
  • Can you as a reviewer explain and take ownership of these elements presented in this code review?

@codecov
Copy link

codecov bot commented Jan 14, 2022

Codecov Report

Merging #1548 (166d8e9) into raft-tdp-main (2d26229) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@              Coverage Diff               @@
##           raft-tdp-main    #1548   +/-   ##
==============================================
  Coverage          97.58%   97.58%           
==============================================
  Files                 80       80           
  Lines               1901     1901           
  Branches             249      249           
==============================================
  Hits                1855     1855           
  Misses                22       22           
  Partials              24       24           
Flag Coverage Δ
dev-backend 99.10% <ø> (ø)
dev-frontend 94.76% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2d26229...166d8e9. Read the comment docs.

@riatzukiza riatzukiza changed the base branch from raft-tdp-main to feat/1545-add-site-files January 19, 2022 15:06
@riatzukiza riatzukiza changed the title Feat/1545 migrate live comms site Feat/1545 (part 2) Setup deployment for live comms site Jan 19, 2022
@riatzukiza riatzukiza added the raft review This issue is ready for raft review label Jan 19, 2022
live-comms/index.html Outdated Show resolved Hide resolved
Copy link

@jorgegonzalez jorgegonzalez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@riatzukiza riatzukiza force-pushed the feat/1545-migrate-live-comms-site branch from 32acde1 to 5823f7d Compare January 21, 2022 19:16
@riatzukiza
Copy link
Author

Add to main readme documentation about the live-comms static app

@riatzukiza
Copy link
Author

Remove top nav

@riatzukiza riatzukiza added QASP Review and removed raft review This issue is ready for raft review labels Jan 24, 2022
@@ -54,7 +54,7 @@
<div class="usa-navbar">
<div class="usa-logo" id="basic-logo">
<em class="usa-logo__text">
<a href="#main-content" title="TDP Project Updates">
<a href="/index.html" title="TDP Project Updates">
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@riatzukiza can you confirm that this line of code reflects the change you mentioned in tabletop?

@@ -1 +1,23 @@
# Design Environment for web hosted live comms

The live comms website is for communicating
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@reitermb could you add a suggestion here that includes more description of the site?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ADPennington Just committed a small update including a few changes there Aaron and I co-worked that got lost somewhere along the line.

live-comms/August-2021-Update.html Outdated Show resolved Hide resolved
live-comms/August-2021-Update.html Show resolved Hide resolved
live-comms/June-2021-Update.html Outdated Show resolved Hide resolved
live-comms/June-2021-Update.html Show resolved Hide resolved
live-comms/June-2021-Update.html Show resolved Hide resolved
<span>August 2021</span>
</a>
</li>
<li class="usa-nav__primary-item">
<a href="June-2021-Update" class="usa-current" aria-current="page">
<a href="June-2021-Update.html" class="usa-current" aria-current="page">
<span>August 2021</span>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<span>August 2021</span>
<span>June 2021</span>

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1548

Copy link
Collaborator

@ADPennington ADPennington left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@riatzukiza @reitermb one suggestion below before this is ready to go. looks great!

@reitermb
Copy link

@ttran-hub this is the PR that's in sync with the test environment version I sent your way if you'd like to add any review here!

Base automatically changed from feat/1545-add-site-files to raft-tdp-main January 28, 2022 15:42
Copy link
Collaborator

@ADPennington ADPennington left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @riatzukiza @reitermb @ttran-hub 👍🏾

@jorgegonzalez jorgegonzalez merged commit bd7c621 into raft-tdp-main Jan 28, 2022
@jorgegonzalez jorgegonzalez deleted the feat/1545-migrate-live-comms-site branch January 28, 2022 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate Design's Live Comms Site into the TANF-app repo.
5 participants