[ETL-602] Compile documentation for recover #105
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BryanFauble
reviewed
Feb 12, 2024
CONTRIBUTING.md
Outdated
| @@ -84,7 +84,23 @@ Before and/or after code review, clean up your commit history. If the `main` bra | |||
|
|
|||
| ### Post review | |||
|
|
|||
| Once the pull request has been approved, we expect _you_ to merge. Although this pulls your commits into the `main` branch, it does not yet deploy your changes to the `main` production pipeline. RECOVER data has FISMA restrictions, but only our production account is FISMA compliant. Since there is no guarantee that the test data provided to us (which doesn't have FISMA restrictions) perfectly models the production dataset, we maintain a `staging` namespace in the production account which enables us to test changes on production data before pulling those changes into the `main` namespace. Merging into `main` will deploy the changes to the `staging` namespace. To complete deployment to the `main` namespace of production, we push a new tag with a specific format to this repository, which will trigger [this GitHub action](.github/workflows/upload-and-deploy-to-prod-main.yaml). There is a diagram of this process [here](https://sagebionetworks.jira.com/wiki/spaces/IBC/pages/2863202319/ETL-390+RECOVER+Integration+Testing#Implementation). | |||
| Once the pull request has been approved, we expect _you_ to merge. Although this pulls your commits into the `main` branch, it does not yet deploy your changes to the `main` production pipeline. RECOVER data has FISMA restrictions, but only our production account is FISMA compliant. Since there is no guarantee that the test data provided to us (which doesn't have FISMA restrictions) perfectly models the production dataset, we maintain a `staging` namespace in the production account which enables us to test changes on production data before pulling those changes into the `main` namespace. Merging into `main` will deploy the changes to the `staging` namespace. To complete deployment to the `main` namespace of production, we push a new tag with a specific format to this repository, which will trigger [this GitHub action](.github/workflows/upload-and-deploy-to-prod-main.yaml). There is a diagram of this process [here](https://sagebionetworks.jira.com/wiki/spaces/IBC/pages/2863202319/ETL-390+RECOVER+Integration+Testing#Implementation). See [release process](#release-process) for more details on this. | |||
There was a problem hiding this comment.
Could you add something here that mentions Squash and merge?
https://sagebionetworks.jira.com/wiki/spaces/IBC/pages/2741797027/GitHub+Git#Merging-a-Pull-Request
BryanFauble
reviewed
Feb 12, 2024
CONTRIBUTING.md
Outdated
| @@ -84,7 +84,23 @@ Before and/or after code review, clean up your commit history. If the `main` bra | |||
|
|
|||
| ### Post review | |||
|
|
|||
| Once the pull request has been approved, we expect _you_ to merge. Although this pulls your commits into the `main` branch, it does not yet deploy your changes to the `main` production pipeline. RECOVER data has FISMA restrictions, but only our production account is FISMA compliant. Since there is no guarantee that the test data provided to us (which doesn't have FISMA restrictions) perfectly models the production dataset, we maintain a `staging` namespace in the production account which enables us to test changes on production data before pulling those changes into the `main` namespace. Merging into `main` will deploy the changes to the `staging` namespace. To complete deployment to the `main` namespace of production, we push a new tag with a specific format to this repository, which will trigger [this GitHub action](.github/workflows/upload-and-deploy-to-prod-main.yaml). There is a diagram of this process [here](https://sagebionetworks.jira.com/wiki/spaces/IBC/pages/2863202319/ETL-390+RECOVER+Integration+Testing#Implementation). | |||
| Once the pull request has been approved, we expect _you_ to merge. Although this pulls your commits into the `main` branch, it does not yet deploy your changes to the `main` production pipeline. RECOVER data has FISMA restrictions, but only our production account is FISMA compliant. Since there is no guarantee that the test data provided to us (which doesn't have FISMA restrictions) perfectly models the production dataset, we maintain a `staging` namespace in the production account which enables us to test changes on production data before pulling those changes into the `main` namespace. Merging into `main` will deploy the changes to the `staging` namespace. To complete deployment to the `main` namespace of production, we push a new tag with a specific format to this repository, which will trigger [this GitHub action](.github/workflows/upload-and-deploy-to-prod-main.yaml). There is a diagram of this process [here](https://sagebionetworks.jira.com/wiki/spaces/IBC/pages/2863202319/ETL-390+RECOVER+Integration+Testing#Implementation). See [release process](#release-process) for more details on this. | |||
There was a problem hiding this comment.
The content here is pretty dense - Consider bullet points for the required things that need to occur and a paragraph for the additional explanation.
BryanFauble
reviewed
Feb 12, 2024
CONTRIBUTING.md
Outdated
|
|
||
| **Instructions:** | ||
|
|
||
| 1. Once there are important features that need to be added so it’s applied to the production data, we will need to create a new tag and release |
There was a problem hiding this comment.
Suggested change
| 1. Once there are important features that need to be added so it’s applied to the production data, we will need to create a new tag and release | |
| 1. Once there are important features that need to be added we will need to create a new tag and release. Once released it will be applied to production data. |
BryanFauble
reviewed
Feb 12, 2024
CONTRIBUTING.md
Outdated
| **Instructions:** | ||
|
|
||
| 1. Once there are important features that need to be added so it’s applied to the production data, we will need to create a new tag and release | ||
| 1. [Create a new tag and release on the repo](https://github.com/Sage-Bionetworks/recover/releases) through here on the `main` branch. This will auto-create the new tag that you specify and release notes. Also include any known bugs for each release here. |
There was a problem hiding this comment.
Suggested change
| 1. [Create a new tag and release on the repo](https://github.com/Sage-Bionetworks/recover/releases) through here on the `main` branch. This will auto-create the new tag that you specify and release notes. Also include any known bugs for each release here. | |
| 1. [Draft a new release for the repo here](https://github.com/Sage-Bionetworks/recover/releases), specify the `main` branch as the target, and choose a tag name. Click `Generate release notes`, review the content and be sure to include any known bugs for the release. |
There was a problem hiding this comment.
Note: may want to add that you can specify a tag name that doesn't exist to leverage the github auto tag create feature.
BryanFauble
reviewed
Feb 12, 2024
CONTRIBUTING.md
Outdated
|
|
||
| 1. Once there are important features that need to be added so it’s applied to the production data, we will need to create a new tag and release | ||
| 1. [Create a new tag and release on the repo](https://github.com/Sage-Bionetworks/recover/releases) through here on the `main` branch. This will auto-create the new tag that you specify and release notes. Also include any known bugs for each release here. | ||
| 1. Wait for the CI/CD (specifically the [upload-and-deploy-to-prod-main](https://github.com/Sage-Bionetworks/recover/blob/main/.github/workflows/upload-and-deploy-to-prod-main.yaml) GH action which deploys the features to main) to finish successfully |
There was a problem hiding this comment.
Suggested change
| 1. Wait for the CI/CD (specifically the [upload-and-deploy-to-prod-main](https://github.com/Sage-Bionetworks/recover/blob/main/.github/workflows/upload-and-deploy-to-prod-main.yaml) GH action which deploys the features to main) to finish successfully | |
| 1. Wait for the CI/CD (specifically the [upload-and-deploy-to-prod-main](https://github.com/Sage-Bionetworks/recover/blob/main/.github/workflows/upload-and-deploy-to-prod-main.yaml) GH action which deploys the features to main) to finish successfully. |
thomasyu888
approved these changes
Feb 13, 2024
philerooski
approved these changes
Feb 13, 2024
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose: See original JIRA ticket for more info. This adds information about the use of github tags and release (yes releases) for version control in the RECOVER ETL in the contributing docs