Overview

As a developer, we need the develop and main branches to be in sync so that the code base is clean and we can more easily collaborate.

Deadline: 11/14/2024

Action Items

• Create a protected branch of main called ava-main-v1 to preserve all their old work. This will separate v1 from v2 (pre backend reset vs post backend reset).
• Merge main into develop
• Test all the changes in develop. Ideally in a staging environment
• Review code (175 files changed)
• Double check github actions to see if any of them are effected.
• Mkdocs gh action needs to be updated to deploy from main
• Execute pull request to Merge develop into main
• Write documentation

This issue Depends on these deployment tasks:

• Important: deploy develop branch to AWS as a staging environment to fully test current changes.
• we need an understanding of the exact process of how the main branch is currently deployed to AWS incubator
• Migrate build-deploy-stage.yml gh action to v4 (actions/checkout@v3)
• Integrate whitenoise
• prepare develop branch for a staging deployment

The deployment for the develop branch should be totally separate from what we have now (stage.civictechjobs.org). This way we can test and confirm a develop deployment is fully functional before pushing to main.

Deprioritized tasks:

• Write Documentation about how the stage docker environment works.

Resources/Instructions

https://stage.civictechjobs.org/

Resources

gh action v4 migration docs:

• https://github.com/actions/upload-artifact?tab=readme-ov-file#breaking-changes
• https://github.com/actions/upload-artifact/blob/main/docs/MIGRATION.md

Deploying a django app:

• https://developer.mozilla.org/en-US/docs/Learn/Server-side/Django/Deployment
• https://docs.djangoproject.com/en/5.1/howto/deployment/