Skip to content

Refactor and clean up the createStagingDeployIssue code #9999

Closed

Description

@mountiny

Problem

Coming from #9946 (comment)

The code for creating staging deploy issue is very hard to follow and leads to bugs when new features are added or code is changed as engineers have tough time following the code.

Also sometimes we can manually move PRs to be internalQA after being added to the checklist - try to check if the PRs in main section are indeed internal or not before adding them in - do not rely on previous checklist in terms of this.

Why is this important?

Intoruduced more bugs in the issues which slows down deploy and takes more time to fix.

Solution

We should do:

  • clean up and refactor the code/flow so it is easier to follow
  • make sure to add more comments which will clearly indicate what are the formats/structures of the arrays/objects and in general comments explaining the flow
  • Find a nicer way to get the URL from the internal QA section than this
    url: match[2].split('-')[0].trim(),

And:

Also sometimes we can manually move PRs to be internalQA after being added to the checklist - try to check if the PRs in main section are indeed internal or not before adding them in - do not rely on previous checklist in terms of this.

Lets also update naming to make sure it is not outdated:

replace StagingDeployCash with DeployChecklist, and LockCashDeploys with LockDeploys

cc @roryabraham

Activity

  1. self-assigned this
    on Jul 19, 2022
  2. mountiny commented on Aug 15, 2022

    @mountiny
    ContributorAuthor

    Low priority for now

  3. mountiny commented on Sep 14, 2022

    @mountiny
    ContributorAuthor

    Focusing on API refactors and n7

  4. mountiny commented on Oct 17, 2022

    @mountiny
    ContributorAuthor

    Still in my backlog, I will let this once to the pool if anyone is interested

  5. removed their assignment
    on Oct 17, 2022
  6. roryabraham commented on Oct 17, 2022

    @roryabraham
    Contributor

    Overall I think we may have lost the context for this issue and the problem is unclear. I think we should refine the problem statement or close this out.

  7. mountiny commented on Oct 18, 2022

    @mountiny
    ContributorAuthor

    @roryabraham I think the general goal was to mrefactor the entire code to me more accessible to unfamiliar developers. A bit vague goal I know.

    However, coming back to what you mentioned before offshore, about reworking the deploy process, is there anything you planned for the deploy checklist and how we create it? then we might just close this out and focus on this later

  8. 1 remaining item

  9. melvin-bot commented on Oct 18, 2022

    @melvin-bot

    Triggered auto assignment to @puneetlath (AutoAssignerTriage), see https://stackoverflow.com/c/expensify/questions/4749 for more details.

  10. added and removed
    AutoAssignerTriageAuto assign issues for triage to an available triage team member
    on Oct 18, 2022
  11. added
    NewFeatureSomething to build that is a new item.
    and removed
    ImprovementItem broken or needs improvement.
    on Oct 18, 2022
  12. removed their assignment
    on Oct 18, 2022
  13. added
    InternalRequires API changes or must be handled by Expensify staff
    on Oct 18, 2022
  14. roryabraham commented on Oct 18, 2022

    @roryabraham
    Contributor

    I didn't really have anything major planned for the checklist other than removing some outdated naming (i.e: replace StagingDeployCash with DeployChecklist, and LockCashDeploys with LockDeploys)

  15. self-assigned this
    on Oct 19, 2022
  16. mountiny commented on Oct 19, 2022

    @mountiny
    ContributorAuthor

    Alright, I think from the bugZero perspective, we can close this one out. The issue got created when we were trying to add a new feature to the checklist and it revealed how easy it is to miss something in the complicated code. However, we havent had issues with the checklist for a long time or needs to change it so I think we could close this now and if there would be any new bigger changes required for the checklist in future, the refactoring should take place along with it.

    Let me know if you disagree.

  17. puneetlath commented on Oct 19, 2022

    @puneetlath
    Contributor

    Sounds good to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

EngineeringInternalRequires API changes or must be handled by Expensify staffMonthlyKSv2NewFeatureSomething to build that is a new item.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions