Should work as an npm package being run locally

[domharrington]

You should be able to do this and have it push the spec files:

BASE_URL=http://localhost:3000 npx @readme/[email protected] './*{yaml,yml,json}' --key=xxx

Right now the server returns with an error:

data: {
  name: 'TypeError',
  message: "Cannot read property 'repository' of undefined"
}

Which is to be expected, because getContext() doesnt return with anything when in a non-CI environment:

readme-micro/lib/context.js

Lines 78 to 79 in 5b596c7

	default:
	return {};

We could probably build a context from local? Grab the repo name from git origins?

[cvan]

• create a mock context (similar to the Bitbucket one) for local usage (when ci.isCI === false).
• use the same mock context - for the list of CI vendors that Micro does not yet support (when ci.name/ci.constant is unmatched).

suggestions

• use npm's official normalize-package-data package, which among other things, will normalize the package.json, filling in the repository, if it's able to.
• recommend using nektos/act to simulate GitHub Actions locally
• look at how serverless projects (that support GH Actions, et al.) handle non-CI environments