chore: set up auto for versioning/release management

[hydrosquall]

Motivation

• Unified versioning / release process through the Vega org:
  • less time spent spent to rebuild packages locally/releasing/managing changelogs = more time for new features

Changes

• Replicate the setup in chore: set up auto for versioning/release management ts-json-schema-generator#856, + updates documentation
  • Needed to switch to json-based config because something about the TSconfig / eslint settings weren't playing nicely with a JS based configuration file. Might revisit this later once I have a clearer idea of what Beemo is doing (haven't used it before).
• Pinned 723f22c3b9fec8705988dcba0802e6df9cbb4d82 to stable
• Documented guidelines re: merging strategies
  • Notes: https://rietta.com/blog/github-merge-types/

Testing

• CI should pass

Admin Todos

• Add a github token like we have for the other repo (secrets.GH_PAT) (not needed since we're not applying a branch protection rule, the default GITHUB_TOKEN will work
• I've copied the current master to next (let's switch this to the default branch)

📦 Published PR as canary version: 0.26.1--canary.566.30d5119.0

✨ Test out this PR locally via:

npm install [email protected]
# or 
yarn add [email protected]

[domoritz]

How should we merge the pull request? I think it would be good to document the merge strategy.

[hydrosquall]

From vega/ts-json-schema-generator@2005b30

[domoritz]

Just wondering, why do we need PAT instead of just a simple GITHUB_TOKEN (https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret)?

[hydrosquall]

Just wondering, why do we need PAT instead of just a simple GITHUB_TOKEN (https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret)?

a PAT would be needed if we made the base branch a protected branch (https://github.community/t/how-to-push-to-protected-branches-in-a-github-action/16101 ), which is what I assumed was happening in the tsconfig repo. However it looks like that isn't needed in this repo, so I've switched back to reading a regular GITHUB_TOKEN.

[domoritz]

I think I added the branch protection later. I'm happy not to have it if that simplifies the setup.

[hydrosquall]

I think there’s value in having the protected branch for high throughput repos especially if there are multiple maintainers (auto docs recommend protecting the pre-release branch), but it would lead to needing to set an admin level PAT for each repo that used this protection. I defer to your lead about what makes sense for the Vega org, I’ll just use the same pattern as we spread this deployment config around.

…

On Mon, Jul 26, 2021 at 11:46 PM Dominik Moritz ***@***.***> wrote: I think I added the branch protection later. I'm happy not to have it if that simplifies the setup. — You are receiving this because you were assigned. Reply to this email directly, view it on GitHub <#566 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACE2MM2TIV467USRXJ5YR43TZYTZVANCNFSM5BBF6E5Q> .

[domoritz]

Since the release branch is just a part of next, I don't think it's too dangerous not to protect it. Let's leave it as is for now.

[hydrosquall]

Since the release branch is just a part of next, I don't think it's too dangerous not to protect it. Let's leave it as is for now.

Sounds good! In that case, I think this PR is good to merge. We should also switch next to the default branch, unless you spot anything else that should be changed/documented.

[domoritz]

We missed to update the default branch in https://github.com/vega/vega-tooltip/blob/next/.github/workflows/test.yml. Just noting so that we update it next time we make a transition.

[github-actions]

🚀 PR was released in v0.27.0 🚀

[hydrosquall]

ah - thanks for catching that!

…

On Wed, Jul 28, 2021 at 12:58 PM Dominik Moritz ***@***.***> wrote: We missed to update the default branch in https://github.com/vega/vega-tooltip/blob/next/.github/workflows/test.yml. — You are receiving this because you were assigned. Reply to this email directly, view it on GitHub <#566 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACE2MM5HQQOHKPDCTDZ7E6TT2AZLPANCNFSM5BBF6E5Q> .