Skip to content

Updating an existing ESR report repo #16

@CarissaGervasi-NOAA

Description

@CarissaGervasi-NOAA

We had a discussion about updating the Caribbean ESR for 2026 and how we should go about editing the repository (we don't want the webpage to be in this constant transition state). After some digging I think I found a good workflow. Brendan was right, you can have branches within branches (called feature branches). Apparently this is what developers do. We treat it like a hierarchy.

  • main branch (does not get touched until the new report is finished and ready to go live)
    • update-2026 branch (essentially our main branch through the development phase)
      • sst-2026 (feature branch created by collaborator who is working on updating a specific part of the report)

So our workflow would be this:

  1. Create a release (like v2025) to preserve the repo as it is now.
  2. Create a new development branch (like update-2026). This will essentially be our working main branch.
  3. Whenever one of us wants to update part of the report, make a feature branch within the update-2026 branch, make necessary updates, and do a pull request to update-2026.
  4. When we are all happy with the report, we can do a final pull request back to the main branch and the html page for the report will be updated with the github action.

@BrittanyTroast-NOAA @MandyKarnauskas-NOAA @BrendanTurley-NOAA @willklaj how does this sound?

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions