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

chore: update CI base branch from main -> next, document publish process #73

Merged
merged 3 commits into from
Dec 19, 2021

Conversation

hydrosquall
Copy link
Member

@hydrosquall hydrosquall commented Jul 30, 2021

Motivation

  • Presently, every update tagged with release to data-explorer would modify the latest channel on NPM. Having a separate pre-release channel allows bugs / features to be tested by those opting in to an experimental version before rolling out to everyone.
  • This PR permits every accepted PR to go out to next tag for ease of testing, but allows maintainers to control the rate of outflow to the main latest tag through manual merges from next -> stable.

Changes

Background / Notes

  • Similar

Original message from Nteract slack channel:

(Process suggestion) - merging into stable to create a production release

I've been setting up build systems for a few projects lately, and noticed a pattern that we might find useful here (storybookjs/storybook is probably the biggest example)

Rather than having main as the base branch, projects are releasing a dev /next prerelease as the default branch. That branch always releases a new version to the next tag on NPM. To make a stable release that updates the latest tag on NPM, you just merge next into your production branch (I recommend calling it stable ).

I think this would be a good pattern to follow in data-explorer too, but wanted to check with others before making the chance. (It would affect modifying the workflows in the .github folder to check for next instead of main as the primary branch). The effect of this is that instead of remembering to apply tags to decide whether or not a PR should be released to NPM upon merge, you can safely approve everything right into the pre-release branch, and do any necessary fixes before it gets merged into stable for an "official" release.

Let me know if you have any questions or concerns about how this would work (I'll leave this open for a week to give people time to see/think about it before doing anything).

Some additional background on the rationale behind this release process:

vega/ts-json-schema-generator#856 (comment)

sets up a 2-branch release process, as recommended by the auto docs
@vercel
Copy link

vercel bot commented Jul 30, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/nteract/data-explorer/F51etLCi7m2vznKtNJAh4YKW9Tk7
✅ Preview: https://data-explorer-git-feature-update-release-process-nteract.vercel.app

@hydrosquall hydrosquall changed the title chore: update CI branches + document publishing processing chore: update CI base branch from main -> next, document publish process Jul 30, 2021
@hydrosquall hydrosquall self-assigned this Jul 30, 2021
Copy link
Member

@willingc willingc left a comment

Choose a reason for hiding this comment

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

Circling back to open source. Thank you!

@willingc willingc merged commit 2985d4d into next Dec 19, 2021
@willingc willingc deleted the feature/update-release-process branch December 19, 2021 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants