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

Update Docs: Netlify Deploy Should Be Through CLI, Not Website #2347

Merged
merged 4 commits into from
Dec 2, 2024

Conversation

Bojun-Feng
Copy link
Contributor

Description

Describe your PR! If it fixes specific issue, mention it with "Fixes # (issue)".

Fixes #2344
Fixes #1982

Select what type of change this PR introduces:

  1. Just code/docs improvement (no functional change).
  2. Bug fix (non-breaking change which fixes an issue).
  3. New feature (non-breaking change which adds functionality).
  4. Breaking change (fix or feature that would cause existing functionality to not work as expected).

Update Waspc ChangeLog and version if needed

If you did a bug fix, new feature, or breaking change, that affects waspc, make sure you satisfy the following:

  1. I updated ChangeLog.md with description of the change this PR introduces.
  2. I bumped waspc version in waspc.cabal to reflect changes I introduced, with regards to the version of the latest wasp release, if the bump was needed.

Update example apps if needed

If you did code changes and added a new feature or modified an existing feature, make sure you satisfy the following:

  1. I updated waspc/examples/todoApp as needed (updated modified feature or added new feature) and manually checked it works correctly.
  2. I updated waspc/headless-test/examples/todoApp and its e2e tests as needed (updated modified feature and its tests or added new feature and new tests for it).

@Bojun-Feng
Copy link
Contributor Author

@Martinsos I have added a warning with my docker file attached as an example. Can we have this merged please?

Let me know if anything else needs to be changed!

Copy link
Member

@Martinsos Martinsos left a comment

Choose a reason for hiding this comment

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

Thanks, this is looking quite good! Left some comments, nothing super major, let's work a bit on those and we should be able to merge!

web/docs/advanced/deployment/manually.md Outdated Show resolved Hide resolved
web/docs/advanced/deployment/manually.md Outdated Show resolved Hide resolved
@Bojun-Feng
Copy link
Contributor Author

@Martinsos Thank you so much for the detailed feedback! I have resolved the comments. Please let me know if there is anything else I can do.

Copy link
Member

@Martinsos Martinsos left a comment

Choose a reason for hiding this comment

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

All right, looking good, thanks for this!

@Martinsos Martinsos merged commit 14e7319 into wasp-lang:main Dec 2, 2024
:::note
Make sure you set this URL as the `WASP_WEB_CLIENT_URL` environment variable in your server hosting environment (e.g., Fly.io or Heroku).
:::

### Deploying through Github Actions
Copy link
Member

Choose a reason for hiding this comment

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

@infomiho I just merged this PR by a contributor. They made it clear that if deploying on Netlify, we need redirectin to be correctly set (either manually or using our netlify.toml).

They also added this section though, which shows how to exactly do it via Github Action. I approved it and merged, but I do wonder if this is too much for this part of the docs, are we going too far / doing too much here. Since you are now redesigning deployment docs I wanted to hear what you think. Maybe we will have a specific Github Actions section and this will be better explained there directly, instead of here under Netlify? Should we matbe (re)move this part?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Martinsos @infomiho Just wanted to hear your opinion on something similar: I am interested in writing documentation to deploy OpenSaaS on AWS (either EC2 or Lightsail), probably also including GitHub Actions to handle CI/CD.

I imagine I will briefly describe the peculiarities related to AWS, but maybe the GitHub Actions code is a bit too much? If that is the case I can put the detailed code that works with a particular version of OpenSaaS into a separate blog post, and only cover the general steps in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Google Auth Redirection Not Working (Netlify & AWS) Properly document our client deployment
2 participants