Skip to content
New issue

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

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

Already on GitHub? # to your account

Don't redeploy docs on push to master #316

Merged
merged 1 commit into from
Mar 10, 2023
Merged

Don't redeploy docs on push to master #316

merged 1 commit into from
Mar 10, 2023

Conversation

ianroberts
Copy link
Member

Since in normal circumstances the master branch should only advance via PRs from dev, there is no need to re-deploy the docs on pushes to master. At best, a deploy from master will be identical to the latest deploy from dev, at worst (if we deploy a hotfix to master without going through dev first) the master deploy will overwrite the latest dev docs with an earlier version and leave the published docs out of date with respect to the latest dev code.

This happened yesterday (2023-03-09) with the merge of #310, which deleted the privacy policy section from the development docs - I've since manually re-run the documentation.yml workflow on dev to re-instate the correct version.

Since in normal circumstances master should only advance via PRs from dev, there is no need to re-deploy the docs on pushes to master.  At best, a deploy from master will be identical to the latest deploy from dev, at worst (if we deploy a hotfix to master without going through dev first) the master deploy will overwrite the latest dev docs with an earlier version.
@ianroberts
Copy link
Member Author

Don't know whether this is worth cherry-picking direct to master or if we can just change it on dev and let it propagate naturally at the next release.

@github-actions
Copy link

Jest Coverage

File % Stmts % Branch % Funcs % Lines Uncovered Line #s
All files 78.2 76.63 71.66 78.2
File % Stmts % Branch % Funcs % Lines Uncovered Line #s
All files 78.2 76.63 71.66 78.2
_src/components 77.14 77.35 85.71 77.14
_ AnnotationRenderer.vue 76.23 77.35 84 76.23 126,141-142,196,219,240,247-261,269,275-285,319
_ MarkdownEditor.vue 100 100 100 100
_ MarkdownRenderer.vue 100 100 100 100
_src/components/annotation 78.57 86.66 76.47 78.57
_ CheckboxInput.vue 85.71 100 100 85.71 19
_ HtmlDisplay.vue 80 100 100 80 26-30
_ InputErrorDisplay.vue 100 0 100 100 19-25
_ RadioInput.vue 71.42 100 66.66 71.42 19,26
_ SelectorInput.vue 71.42 100 66.66 71.42 20,27
_ TextInput.vue 75 100 66.66 75 26
_ TextareaInput.vue 66.66 100 50 66.66 20
_src/enum 100 100 100 100
_ DocumentTypes.js 100 100 100 100
_src/jrpc 90.32 83.33 75 90.32
_ index.js 90.32 83.33 75 90.32 29,38-39
_src/utils 70.58 69.69 27.27 70.58
_ annotations.js 100 100 100 100
_ dict.js 100 100 100 100
_ index.js 55.88 54.54 11.11 55.88 9-14,28-93
_tests/unit 100 100 100 100
_ globalVue.js 100 100 100 100

@twinkarma
Copy link
Collaborator

We should be ok to just merge it to dev and leave it, we'll be looking to do a deploy to master right after I've done the user delete functionalities.

@twinkarma twinkarma merged commit 740a1cd into dev Mar 10, 2023
@ianroberts ianroberts deleted the build-docs-dev-only branch April 14, 2023 16:36
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants