-
-
Notifications
You must be signed in to change notification settings - Fork 633
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: set up auto for versioning/release management #7972
Conversation
The main tricky thing in Vega-Lite is that we need to update this file whenever we bump the version number. The next tricky thing is to update the website and schema repo as well, which we do in https://github.com/vega/vega-lite/blob/master/.github/workflows/release.yml. We should probably not push schema updates with every pre-release and we should also not update the website until we have a path/minor/major release. I'm happy to answer any questions. |
I think we can get away with only updating this on the If it turns out to be necessary, I can write a custom lifecycle plugin to write the version to that file whenever "auto" has its auto-version command called. However, I'd like to avoid it if possible since it may be harder for future maintainers to know about/debug. I wonder if we could make it an option for this file to be built dynamically as part of the site's build step from the version in the
I figured - I thought about it for a while, and decided to leave the |
I'd like to not have to manually update the version file. I like the idea of getting rid of it entirely. |
Opened separately as #7983 |
1b4c321
to
e4b5540
Compare
e4b5540
to
bb24d99
Compare
@@ -6,7 +6,7 @@ version=$(scripts/version.sh vega-lite) | |||
|
|||
pushd ../schema/vega-lite/ | |||
|
|||
git checkout master |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm undoing this branch renaming since it looks like it's a script meant to run in a different repository
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch
068f3c9
to
506bd9e
Compare
@@ -37,12 +40,6 @@ jobs: | |||
- uses: actions/setup-node@v2.5.1 | |||
with: | |||
registry-url: 'https://registry.npmjs.org' | |||
- name: Publish to NPM registry |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was removed because it's already been released once on the trigger to the push
event
I'm no longer able to push commits to this branch due to some kind of Github authentication error. The error message is misleading as I'm not using a PAT to authenticate "git pushes" locally. Closing this PR and reopening as #7984 . |
Motivation
Changes
Replicate the setup in chore: set up auto for versioning/release management vega-tooltip#566
Left the documentation + schema publishing steps intact, updated workflows to only trigger those
Figure out a way to dry-run a test of the documentation publishing step from
stable
Discussion topics
script/bump.sh
is not relevant. I didn't want to remove the script until reviewing this with @domoritz . I outline what will happen if we abandon this script on pre-releases, and lean on "auto" to manage version bumps instead.next
will lag the version instable
, leading to PRs like chore: sync prerelease branch version with stable vega-tooltip#575 .auto
: [question]: Best practices for synchronizing versions in a two-branch prerelease workflow intuit/auto#2047 . I think it's OK as long as we only ever publish documentation fromstable
. (I think this is a reasonable trade, I don't think we want to be publishing documentation updates before stable releases are made)next
branch, at the cost of not being able to do prereleases, and requiring you to manually use therelease
tag.Pre-merge checklist for a repo admin
next
from the current head ofmaster
https://github.com/vega/vega-lite/tree/nextnext
the base branch of this PR instead ofmaster
next
the base branch for the whole repostable
from the latest tagv5.2.0
https://github.com/vega/vega-lite/tree/stableskip-release
andreleased
in this repo (the first is used to tell auto not to release anything if this PR is released, the second is used to tag PRs that have been released).