Set up a basic landing page, install instructions #299
Conversation
🎉 Are we earthbuild yet?Great progress! You've reduced "earthly" occurrences by 1 (0.02%) 📈 Overall Progress
📁 Changes by file type:
Keep up the great work migrating from Earthly to Earthbuild! 🚀 💡 Tips for finding more occurrencesRun locally to see detailed breakdown: ./.github/scripts/count-earthly.shNote that the goal is not to reach 0. |
Summary of ChangesHello @kmannislands, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request lays the groundwork for EarthBuild's public-facing presence by implementing a basic landing page and a comprehensive installation guide. It provides essential information about the project, its features, and clear steps for users to get started, while also setting up the necessary infrastructure for web deployment and automated installation. Highlights
Ignored Files
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request sets up a basic landing page and installation instructions for EarthBuild. The changes include new HTML pages for the landing page and installation guide, a CNAME file for the custom domain, and a new install.sh script. The overall structure is good. I've found a bug in the installer script for users who have wget but not curl, and I've also suggested an improvement to the manual installation instructions on the website to make them more generic for different CPU architectures. The rest of the changes look good.
| if command -v curl >/dev/null 2>&1; then | ||
| VERSION=$(curl -fsSI -o /dev/null -w '%{url_effective}' "$LATEST_URL" | sed 's|.*/||') | ||
| elif command -v wget >/dev/null 2>&1; then | ||
| VERSION=$(wget --spider --max-redirect=0 "$LATEST_URL" 2>&1 | grep -o 'releases/tag/[^"]*' | head -1 | sed 's|releases/tag/||') |
There was a problem hiding this comment.
The grep pattern to extract the version tag for wget users is incorrect. It uses [^"*], which can cause it to match more than just the version tag (e.g., v0.8.5 [following]). This results in an invalid version string. Using [^ ]* instead will correctly stop matching at the first space, ensuring only the tag is captured.
| VERSION=$(wget --spider --max-redirect=0 "$LATEST_URL" 2>&1 | grep -o 'releases/tag/[^"]*' | head -1 | sed 's|releases/tag/||') | |
| VERSION=$(wget --spider --max-redirect=0 "$LATEST_URL" 2>&1 | grep -o 'releases/tag/[^ ]*' | head -1 | sed 's|releases/tag/||') |
| <pre><code># Download the latest release | ||
| curl -LO https://github.com/EarthBuild/earthbuild/releases/latest/download/earth-linux-amd64 | ||
|
|
||
| # Make it executable | ||
| chmod +x earth-linux-amd64 | ||
|
|
||
| # Move to your PATH | ||
| sudo mv earth-linux-amd64 /usr/local/bin/earth</code></pre> |
There was a problem hiding this comment.
The manual installation instructions for Linux are hardcoded for the amd64 architecture. This can be confusing for users on other architectures like arm64, which the installer script supports. The commands can be improved by using a variable for the architecture, making it easier for users to adapt for their system. For example:
# Set your architecture (e.g., amd64, arm64)
ARCH=amd64
# Download the latest release for your architecture
curl -LO "https://github.com/EarthBuild/earthbuild/releases/latest/download/earth-linux-${ARCH}"
# Make it executable
chmod +x "earth-linux-${ARCH}"
# Move to your PATH
sudo mv "earth-linux-${ARCH}" /usr/local/bin/earth
kmannislands
had a problem deploying
to
github-pages
GitHub Actions
Failure
Closes #199
This PR implements the install page and a basic landing page to be improved on more down the road.