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

Add deployment guide for Heroku #1617

Merged
merged 27 commits into from
Oct 28, 2022
Merged

Add deployment guide for Heroku #1617

merged 27 commits into from
Oct 28, 2022

Conversation

zimeg
Copy link
Member

@zimeg zimeg commented Oct 7, 2022

Summary

The steps needed to deploy a next-generation Bolt app to Heroku are captured in this guide [HERMES-3369], as well as a few tips for ongoing app development. All suggestions, comments, missing points, or anything else is most welcomed!

A few notes

  • This guide links out to other guides in the prerequisites section in the interest of brevity.
  • Both the steps for Socket Mode apps and apps using the standard web connection are covered.
  • A neat point (imo) about link trigger functionality in this deployed environment is noted.

Reviewers

To review the changes to the docs, check out the "Generating documentation" documentation then head to http://localhost:4000/bolt-js/future/deploy-your-app.

Requirements

@zimeg zimeg added the docs M-T: Documentation work only label Oct 7, 2022
@zimeg zimeg self-assigned this Oct 7, 2022
@codecov
Copy link

codecov bot commented Oct 7, 2022

Codecov Report

Merging #1617 (81afa8a) into main (3b5f084) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1617   +/-   ##
=======================================
  Coverage   82.09%   82.09%           
=======================================
  Files          18       18           
  Lines        1502     1502           
  Branches      437      437           
=======================================
  Hits         1233     1233           
  Misses        172      172           
  Partials       97       97           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
Copy link
Contributor

@hello-ashleyintech hello-ashleyintech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work, I'm loving the voice and tone of the guide and how thorough it is! Left some feedback and questions, let me know if you'd like to sync up on any of them or feel free to drop me a message 😄 Also sorry for the stray comments! I kept accidentally submitting them instead of putting them all in the same review 🤦

docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
Copy link
Contributor

@hello-ashleyintech hello-ashleyintech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful work and thank you for making those changes! 🙌 I dropped a few more suggestions, let me know your thoughts and if you have any questions!

docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
@zimeg zimeg marked this pull request as ready for review October 26, 2022 18:43
Copy link
Contributor

@hello-ashleyintech hello-ashleyintech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work, this worked like a charm! ✨ I ran through this again and left some suggestions here and there. Feel free to reject or accept suggestions as you see fit, and definitely let me know if there are any questions! 😄

docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
docs/_future/deploy_your_app.md Outdated Show resolved Hide resolved
$ heroku ps:scale web=1
```

#### Using a public web address
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

after reading through this again - what are your thoughts on updating this header title to make it more explicit that this is only a required step if your app isn't using socket mode? I'm not sure what that would look like, maybe something like "Settings for apps not using Socket Mode" but with a bit more indication about what's inside this section?

Copy link
Contributor

@hello-ashleyintech hello-ashleyintech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me! 🙌 🚀

@zimeg zimeg force-pushed the next-gen-deployment-guide branch from c518e11 to 81afa8a Compare October 28, 2022 18:41
@zimeg zimeg merged commit 17f3d97 into main Oct 28, 2022
@zimeg zimeg deleted the next-gen-deployment-guide branch October 28, 2022 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants