Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[HOLD for payment 2023-10-16] Set up preview builds for HelpDot #28531

Closed
roryabraham opened this issue Sep 30, 2023 · 16 comments
Closed

[HOLD for payment 2023-10-16] Set up preview builds for HelpDot #28531

roryabraham opened this issue Sep 30, 2023 · 16 comments
Assignees
Labels
Awaiting Payment Auto-added when associated PR is deployed to production Daily KSv2 NewFeature Something to build that is a new item. ring0

Comments

@roryabraham
Copy link
Contributor

roryabraham commented Sep 30, 2023

Slack context: https://expensify.slack.com/archives/C01GTK53T8Q/p1695766723259829

cc @rushatgabhane

Problem

We can easily make mistakes when adding articles to HelpDot. And testing locally requires setup.
To ensure nothing is breaking, an engineer has to review the PR when adding articles to HelpDot. This takes our precious time!!

Why this is important

We want HelpDot to be mostly maintained by non-engineers. They can create an adjust articles just by creating markdown files. However, they cannot actually test or preview their changes without a dev environment setup.

Solution

Deploy helpsite PR previews to netlify. It generates a deploy preview for PRs. https://docs.netlify.com/site-deploys/deploy-previews/

@roryabraham roryabraham added Daily KSv2 NewFeature Something to build that is a new item. labels Sep 30, 2023
@melvin-bot
Copy link

melvin-bot bot commented Sep 30, 2023

@melvin-bot melvin-bot bot added Weekly KSv2 and removed Daily KSv2 labels Sep 30, 2023
@roryabraham
Copy link
Contributor Author

Setup steps:

  1. create a free Netlify account
  2. deploy existing project using GitHub
  3. install Netlify on Expensify/App

@roryabraham
Copy link
Contributor Author

roryabraham commented Sep 30, 2023

Might need ring0 help for the third step

@rushatgabhane rushatgabhane mentioned this issue Sep 30, 2023
59 tasks
@melvin-bot melvin-bot bot added Reviewing Has a PR in review Weekly KSv2 and removed Weekly KSv2 labels Sep 30, 2023
@roryabraham roryabraham removed the Reviewing Has a PR in review label Sep 30, 2023
@roryabraham
Copy link
Contributor Author

Created Netflify account under reactnative@expensify.com – password is in the ring3 bucket in 1P

@rushatgabhane
Copy link
Member

rushatgabhane commented Sep 30, 2023

@roryabraham we'll need to add a env variable to specify the node version for npm ci to work

nvm, it can be done in config file

@melvin-bot
Copy link

melvin-bot bot commented Sep 30, 2023

Triggered auto assignment to @fukawi2 (ring0), see https://stackoverflow.com/c/expensify/questions/6102 for more details.

@roryabraham
Copy link
Contributor Author

@fukawi2 There should be a pending request to configure Netlify with Expensify/App:

image

@roryabraham
Copy link
Contributor Author

Additional infra discussion: https://expensify.slack.com/archives/C094TGUTZ/p1696058736845509

@roryabraham
Copy link
Contributor Author

Sounds like we might use Cloudflare instead of Netlify for this.

@roryabraham
Copy link
Contributor Author

Tagging in @coleaeason to help set that up - sounds like it will be easy

@roryabraham roryabraham assigned coleaeason and unassigned fukawi2 Sep 30, 2023
@rushatgabhane
Copy link
Member

rushatgabhane commented Sep 30, 2023

@roryabraham awesome, I'll close my PR

Here is the build command -
npm ci && cd docs && bundle install && npm run createDocsRoutes && bundle exec jekyll build

@coleaeason
Copy link
Contributor

Working on this now, should have it done today or tomorrow.

@melvin-bot melvin-bot bot added Reviewing Has a PR in review Weekly KSv2 and removed Weekly KSv2 labels Oct 5, 2023
@coleaeason
Copy link
Contributor

PR is up! Builds will fail until that PR is merged.

@melvin-bot melvin-bot bot added Weekly KSv2 Awaiting Payment Auto-added when associated PR is deployed to production and removed Weekly KSv2 labels Oct 9, 2023
@melvin-bot melvin-bot bot changed the title Set up preview builds for HelpDot [HOLD for payment 2023-10-16] Set up preview builds for HelpDot Oct 9, 2023
@melvin-bot melvin-bot bot removed the Reviewing Has a PR in review label Oct 9, 2023
@melvin-bot
Copy link

melvin-bot bot commented Oct 9, 2023

Reviewing label has been removed, please complete the "BugZero Checklist".

@melvin-bot
Copy link

melvin-bot bot commented Oct 9, 2023

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.3.79-5 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

If no regressions arise, payment will be issued on 2023-10-16. 🎊

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

  • External issue reporter
  • Contributor that fixed the issue
  • Contributor+ that helped on the issue and/or PR

For reference, here are some details about the assignees on this issue:

  • @rushatgabhane does not require payment (Eligible for Manual Requests)

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

  • Merged PR within 3 business days of assignment - 50% bonus
  • Merged PR more than 9 business days after assignment - 50% penalty

@melvin-bot melvin-bot bot added Daily KSv2 and removed Weekly KSv2 Daily KSv2 labels Oct 16, 2023
@rushatgabhane
Copy link
Member

rushatgabhane commented Oct 17, 2023

Thanks for the help everyone! @roryabraham we can close this issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Awaiting Payment Auto-added when associated PR is deployed to production Daily KSv2 NewFeature Something to build that is a new item. ring0
Projects
None yet
Development

No branches or pull requests

5 participants