Skip to content
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

[public-api] Publish to NPM #10052

Merged
merged 1 commit into from
May 17, 2022
Merged

[public-api] Publish to NPM #10052

merged 1 commit into from
May 17, 2022

Conversation

easyCZ
Copy link
Member

@easyCZ easyCZ commented May 16, 2022

Description

Publish public-api typescript defs to NPM so they can be consumed by IDE.

Related Issue(s)

Fixes #

How to test

Release Notes

[public-api] Publish typescript definitions to NPM

Documentation

NONE

@easyCZ easyCZ force-pushed the mp/public-api-publish-npm branch from 6348fe2 to c887240 Compare May 17, 2022 09:44
@roboquat roboquat added size/L and removed size/S labels May 17, 2022
@easyCZ easyCZ marked this pull request as ready for review May 17, 2022 09:45
@easyCZ easyCZ requested a review from a team May 17, 2022 09:45
@github-actions github-actions bot added the team: webapp Issue belongs to the WebApp team label May 17, 2022
"name": "@gitpod/public-api",
"version": "0.1.5",
"license": "UNLICENSED",
"files": [
"client",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why remove this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It didn't point to any actual files so no need to have it. It's only used for the publish.

- components/gitpod-protocol:scripts
config:
commands:
- ["node", "components-gitpod-protocol--scripts/publish.js", "${version}", "components-public-api-typescript--lib/package"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is node able to find publish.js here (the components- don't look like valid paths?)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've no idea! This whole thing looks to be way more complicated than it needs to be but not really well placed to simplify. The code here just mirrors what supervisor-api does

config:
packaging: library
dontTest: true
commands:
build: ["yarn", "build"]
yarnLock: ${coreYarnLockBase}/../yarn.lock
tsconfig: tsconfig.json

- name: publish
Copy link
Contributor

@andrew-farries andrew-farries May 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is this triggered? We already have this:

- name: publish-api
type: generic
deps:
- components/gitpod-protocol:publish
- components/local-app-api/typescript-grpcweb:publish
- components/supervisor-api/typescript-grpc:publish
- components/supervisor-api/typescript-grpcweb:publish
- components/ide/jetbrains/gateway-plugin:publish
- components/public-api/typescript:publish

Does that need to be updated?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure, mirrors supervisor-api setup

@roboquat roboquat merged commit d336cf8 into main May 17, 2022
@roboquat roboquat deleted the mp/public-api-publish-npm branch May 17, 2022 12:16
@roboquat roboquat added deployed: webapp Meta team change is running in production deployed Change is completely running in production labels May 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deployed: webapp Meta team change is running in production deployed Change is completely running in production release-note size/L team: webapp Issue belongs to the WebApp team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants