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

Repo link in README is not replaced #1388

Open
newstler opened this issue Mar 29, 2024 · 3 comments · May be fixed by #1478
Open

Repo link in README is not replaced #1388

newstler opened this issue Mar 29, 2024 · 3 comments · May be fixed by #1478
Labels
bug Something isn't working

Comments

@newstler
Copy link
Contributor

Some why this code doesn't change the repo in README.

@newstler newstler added the bug Something isn't working label Mar 29, 2024
@jagthedrummer
Copy link
Contributor

I think this is related to the fact that we had some bad commits on main.

@jagthedrummer
Copy link
Contributor

I just looked into this and I think it's a legit bug.

There's this line where we ask if you want to setup GitHub:

skip_github = ask "Continue setting up with GitHub? [y/n]"

And then on the next line we test it like this:

if skip_github.downcase[0] == "y"

But then further down the script we do some less specific tests, that don't really test what we want to be testing.

unless skip_github

if skip_github

@jagthedrummer
Copy link
Contributor

jagthedrummer commented May 20, 2024

Relatedly, it seems that we only even attempt to replace the repo URL if you did not choose to setup GitHub. Which seems less than ideal.

bullet_train/bin/configure

Lines 269 to 273 in c73c9c8

unless skip_github
original_repo_link = "https://github.com/bullet-train-co/bullet_train"
new_repo_link = ask "What is the link to your repository? We will use this to enable the one-click deploy to Render button for your application."
replace_in_file("README.example.md", original_repo_link, new_repo_link, /repo=#{original_repo_link}/)
end

If you do setup GitHub we ask you for the ssh variant of the repo URL and not the https variant. But according to the render docs they need the https variant.

Set the value of repo to the full https:// URL for your Git repo.

I think maybe we should explicitly ask if you want to use Render. If you're planning to deploy to Heroku or literally any other deployment target it doesn't really do you any good to have a "deploy to Render" button on your README. In fact, it could really be counterproductive and send people down a dead end.

This is kind of related to the idea that we have too much stuff kind of haphazardly crammed into bin/configure. #1440

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants