-
Notifications
You must be signed in to change notification settings - Fork 34
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
Add deploy to experimental instructions #2278
Conversation
aeb91dc
to
37841a6
Compare
@@ -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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"risky changes like changes to containers, app startup, or connection to data stores"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I should probably also add "secure migrations" to that list.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also add data loads
? (I know I deployed to experimental when loading the 400ng items
)
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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! 🚢
@@ -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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"...test out a branch out." - awk...
"before you merge the code in." - before you merge to master
??
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"You can view it's progress" - change it's
to its
"If it's succeeded" - If it succeeded
??
|
||
## 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! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#dp3-experimental-env
|
||
## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this! I have a few changes requested.
|
||
## 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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ahhh. got it. will change
Codecov Report
@@ 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
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