microsoft / microsoft/beachball

Add pre-publish step to check validity of git auth

Open
#776 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
TypeScript
Stars
815
Forks
93
Avg merge
2d 13h
Merged PRs (30d)
12

Description

The publish flow for beachball is currently as follows:

  1. bump packages locally
  2. publish to npm
  3. push to git

Currently when publishing packages, if the git auth is invalid (due to an expired token, incorrect URL, or other issue), this will result in the repo being out of sync with the published versions.

Therefore, it would be good to add a step prior to npm publish to check the validity of the github auth. I'm not sure what the best command would be to do this, since it appears that git fetch (which is run prior to publishing) succeeds for public repos even with an expired token.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is named in the issue. Start by locating beachball's publish flow and the existing git fetch step, then determine how authentication can be validated before npm publish. Done means invalid git credentials stop publishing while valid credentials preserve the existing publish and push sequence.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, typescript
Domain
release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.