Add deploy to experimental instructions #2278

kahlouie · 2019-06-13T21:22:15Z

Description

Adds documentation about how to deploy to experimental as well as how to clean up after yourself.

Setup

n/a

Code Review Verification Steps

Request review from a member of a different team.

chrisgilmerproj · 2019-06-13T21:30:50Z

docs/how-to/deploy-to-experimental.md

@@ -0,0 +1,25 @@
+# How to Deploy to Experimental
+
+Experimental is the MilMove environment that can be used to test out a branch out. This is especially good if you'd like Product, Design, or the client to test out a change before you merge the code in. It's also a good decision to use experimental to test out particularly risky changes.


"risky changes like changes to containers, app startup, or connection to data stores"

I should probably also add "secure migrations" to that list.

also add data loads? (I know I deployed to experimental when loading the 400ng items)

chrisgilmerproj · 2019-06-13T21:32:04Z

docs/how-to/deploy-to-experimental.md

+      ignore: your_branch_name_goes_here
+```
+
+When you push up to Github, it'll trigger the CircleCI workflow to start. You can view it's progress on [CircleCI's UI](https://circleci.com/gh/transcom/workflows/mymove) and clicking on your branch. If it's succeeded, then it should be up on [SM experimental](https://my.experimental.move.mil/), [Office experimental](https://office.experimental.move.mil/), and [TSP experimental](https://tsp.experimental.move.mil/). Best practices mean you should announce deploys to experimental in the `#dp3-engineering` slack channel, so only one person is trying to use it at the same time.


Announce in the #dp3-experinental-env channel at least 20 minutes before you intend to deploy. Try to get a 👍 from someone who is commonly using experimental. If no one comments in that timeframe feel free to deploy.

"it'll trigger the CircleCI workflow to star immediately". We definitely want people checking in with #dp3-experimental-env prior to pushing their code change.

lynzt

A few nitpicky things, but nice job! Should we add something to say that as soon as you push your branch it will deploy to experimental in a more blatant way? I know you mention it, but might be missed if skimming?

Thanks so much for add this! 🚢

lynzt · 2019-06-13T21:25:44Z

docs/how-to/deploy-to-experimental.md

@@ -0,0 +1,25 @@
+# How to Deploy to Experimental
+
+Experimental is the MilMove environment that can be used to test out a branch out. This is especially good if you'd like Product, Design, or the client to test out a change before you merge the code in. It's also a good decision to use experimental to test out particularly risky changes.


"...test out a branch out." - awk...

"before you merge the code in." - before you merge to master ??

lynzt · 2019-06-13T21:31:36Z

docs/how-to/deploy-to-experimental.md

+      ignore: your_branch_name_goes_here
+```
+
+When you push up to Github, it'll trigger the CircleCI workflow to start. You can view it's progress on [CircleCI's UI](https://circleci.com/gh/transcom/workflows/mymove) and clicking on your branch. If it's succeeded, then it should be up on [SM experimental](https://my.experimental.move.mil/), [Office experimental](https://office.experimental.move.mil/), and [TSP experimental](https://tsp.experimental.move.mil/). Best practices mean you should announce deploys to experimental in the `#dp3-engineering` slack channel, so only one person is trying to use it at the same time.


"You can view it's progress" - change it's to its

"If it's succeeded" - If it succeeded ??

chrisgilmerproj · 2019-06-13T21:36:23Z

docs/how-to/deploy-to-experimental.md

+
+## Don't forget to clean up your branch for your pr review
+
+All of the [how to do it instructions](#How-to-do-it) need to be reverted so all future branches don't get deployed to experimental. Also, be sure to announce in `#dp3-engineering` that experimental is available for someone else to use!


#dp3-experimental-env

chrisgilmerproj · 2019-06-13T21:36:39Z

docs/how-to/deploy-to-experimental.md

+
+## I've got a server-side feature flag
+
+You'll need to add it to [the container definition](https://github.com/transcom/mymove/blob/master/config/app.container-definition.json) in the `environment` array with the name of the server-side flag and the value you'd like it to be on experimental.


Best practice is to add the mustache syntax in that file and follow up by adding the environment variable here: https://github.com/transcom/mymove/blob/master/config/env/experimental.env

chrisgilmerproj

Thanks for doing this! I have a few changes requested.

chrisgilmerproj · 2019-06-13T22:34:10Z

docs/how-to/deploy-to-experimental.md

+
+## I've got a server-side feature flag
+
+You'll need to add it to [experimental config file](https://github.com/transcom/mymove/blob/master/config/env/experimental.env).


I'm sorry I was confusing. You need to put it both in https://github.com/transcom/mymove/blob/master/config/app.container-definition.json and in this other file. Use mustache syntax in the first and just the value in the experimental.env file.

ahhh. got it. will change

codecov · 2019-06-17T23:08:15Z

Codecov Report

Merging #2278 into master will increase coverage by 0.15%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #2278      +/-   ##
==========================================
+ Coverage   59.11%   59.26%   +0.15%     
==========================================
  Files         254      254              
  Lines       14324    14347      +23     
==========================================
+ Hits         8467     8502      +35     
+ Misses       4850     4830      -20     
- Partials     1007     1015       +8

chrisgilmerproj

🚀

kahlouie added the roci label Jun 13, 2019

kahlouie requested review from jim, lynzt and ralren June 13, 2019 21:22

Add deploy to experimental instructions

37841a6

kahlouie force-pushed the kl-add-experimental-deploy-instructions branch from aeb91dc to 37841a6 Compare June 13, 2019 21:23

chrisgilmerproj reviewed Jun 13, 2019

View reviewed changes

lynzt approved these changes Jun 13, 2019

View reviewed changes

chrisgilmerproj reviewed Jun 13, 2019

View reviewed changes

chrisgilmerproj suggested changes Jun 13, 2019

View reviewed changes

Make needed changes

4af656d

chrisgilmerproj reviewed Jun 13, 2019

View reviewed changes

Add both docs that this needs to change in

f46a1d9

chrisgilmerproj approved these changes Jun 17, 2019

View reviewed changes

kahlouie merged commit c0fd220 into master Jun 18, 2019

kahlouie deleted the kl-add-experimental-deploy-instructions branch June 18, 2019 15:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add deploy to experimental instructions #2278

Add deploy to experimental instructions #2278

kahlouie commented Jun 13, 2019

chrisgilmerproj Jun 13, 2019

chrisgilmerproj Jun 13, 2019

lynzt Jun 13, 2019 •

edited

chrisgilmerproj Jun 13, 2019

chrisgilmerproj Jun 13, 2019

lynzt left a comment

lynzt Jun 13, 2019

lynzt Jun 13, 2019

chrisgilmerproj Jun 13, 2019

chrisgilmerproj Jun 13, 2019

chrisgilmerproj left a comment

chrisgilmerproj Jun 13, 2019

kahlouie Jun 17, 2019

codecov bot commented Jun 17, 2019 •

edited

chrisgilmerproj left a comment

		@@ -0,0 +1,25 @@
		# How to Deploy to Experimental

		Experimental is the MilMove environment that can be used to test out a branch out. This is especially good if you'd like Product, Design, or the client to test out a change before you merge the code in. It's also a good decision to use experimental to test out particularly risky changes.


		## Don't forget to clean up your branch for your pr review

		All of the [how to do it instructions](#How-to-do-it) need to be reverted so all future branches don't get deployed to experimental. Also, be sure to announce in `#dp3-engineering` that experimental is available for someone else to use!


		## I've got a server-side feature flag

		You'll need to add it to [the container definition](https://github.com/transcom/mymove/blob/master/config/app.container-definition.json) in the `environment` array with the name of the server-side flag and the value you'd like it to be on experimental.


		## I've got a server-side feature flag

		You'll need to add it to [experimental config file](https://github.com/transcom/mymove/blob/master/config/env/experimental.env).

Add deploy to experimental instructions #2278

Add deploy to experimental instructions #2278

Conversation

kahlouie commented Jun 13, 2019

Description

Setup

Code Review Verification Steps

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lynzt Jun 13, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lynzt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisgilmerproj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jun 17, 2019 • edited

Codecov Report

chrisgilmerproj left a comment

Choose a reason for hiding this comment

lynzt Jun 13, 2019 •

edited

codecov bot commented Jun 17, 2019 •

edited