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 README to reflect making main the default branch #848

Merged
merged 1 commit into from
Jun 18, 2024

Conversation

gabalafou
Copy link
Contributor

@gabalafou gabalafou commented May 28, 2024

This PR updates the README to reflect the discussion on a recent release PR (copy-pasted below).

I also reworded some things and moved two sections to the top:

  • How to publish a blog post
  • Running the website locally

Once it is approved, right after merging it, I will change the setting in GitHub to make main the default branch.

Link: updated README


As for getting rid of the two-stage deploy process, here are some thoughts:

  • Configure main to be the default branch so that blog authors branch off main when working on a blog post
  • If a blog post PR is off main, then when it gets merged, it will be deployed straight away (no more two-stage process)
  • Leave the develop branch in place for riskier changes to the repo that should go through the two-stage deploy process
  • Occasionally we'll need to sync (rebase?) the develop branch with main. Seems to me that main should be the source of truth and develop should mirror main. (The alternative would be merge commits from main to the develop branch but that sounds messy in the long run.)
  • Update the docs to reflect the above

Copy link

vercel bot commented May 28, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
labs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 28, 2024 0:03am

@gabalafou gabalafou requested a review from trallard May 28, 2024 11:46
@gabalafou
Copy link
Contributor Author

gabalafou commented May 28, 2024

NOTE: this pull request branch is against the main branch, since that's the general plan for non-risky changes now.

@gabalafou
Copy link
Contributor Author

Probably need to add something to the README about our plan for keeping the develop branch in sync with the main branch, though I'm not 100% sure what the plan is.

Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

These changes and the new blog post process looks great to me, thanks Gabriel!

I won't merge this now, since it'd be good for at least one of @trallard or @pavithraes to also have a look.

@trallard trallard merged commit 22d858b into main Jun 18, 2024
2 checks passed
@trallard trallard deleted the make-main-main branch June 18, 2024 15:00
@gabalafou
Copy link
Contributor Author

gabalafou commented Jun 18, 2024

Great! I just changed the default branch in the repo settings to main

@pavithraes
Copy link
Member

Thanks! I went through the updates as well, and all looks good. :)

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.

None yet

4 participants