feat: overhaul docs / publish to npm#75
Merged
Merged
Conversation
mnahkies
force-pushed
the
mn/feat/overhaul-docs-for-publishing
branch
from
014bfe8 to
90ad90d
Compare
mnahkies
force-pushed
the
mn/feat/overhaul-docs-for-publishing
branch
from
90ad90d to
3b8cefa
Compare
mnahkies
force-pushed
the
mn/feat/overhaul-docs-for-publishing
branch
3 times, most recently
from
b227f0c to
a6cba44
Compare
mnahkies
force-pushed
the
mn/feat/overhaul-docs-for-publishing
branch
from
a6cba44 to
f6dabae
Compare
asfaltboy
reviewed
Jan 27, 2024
Collaborator
asfaltboy
left a comment
asfaltboy
left a comment
There was a problem hiding this comment.
forgot to submit the review a while back
| nothing particular interesting here, just takes a loaded document and validates it against | ||
| the openapi3 specification in json schema format. | ||
|
|
||
| Useful for detecting emission errors due to bad input rather than bugs in the code generation. |
Collaborator
There was a problem hiding this comment.
Did you mean "omission"? Can also just say:
Suggested change
| Useful for detecting emission errors due to bad input rather than bugs in the code generation. | |
| Useful for detecting errors due to bad input rather than bugs in the code generation. |
| - name: Check for uncommitted changes | ||
| run: ./scripts/assert-clean-working-directory.sh | ||
|
|
||
| # TODO: figure out how to do this safely, eg: no risk of external contributors exfiltrating publish secret. |
Collaborator
There was a problem hiding this comment.
I think secrets are now obfuscated in logs (see below), and without access to the settings I can't access it.
You can try and add some dummy values and enable this (even if auth fails) and I can tell you what I can see and what I can't
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
cleanstepAlpha Published
First alpha versions have been published to npm here: https://www.npmjs.com/package/@nahkies/openapi-code-generator
Testing notes
Publishing scripts have been tested locally using my self-hosted Verdaccio instance and all appears fine.
The markdown links are a bit broken, but I'm fairly sure that's Verdaccio not me.
Additionally manually inspected the contents of the tarball for each package and there are no missing or extraneous files.