Skip to content

chore: Update publish docs#2

Merged
erezrokah merged 1 commit intomainfrom
chore/add_publish_docs
Jan 26, 2024
Merged

chore: Update publish docs#2
erezrokah merged 1 commit intomainfrom
chore/add_publish_docs

Conversation

@erezrokah
Copy link
Copy Markdown
Member

Similar to cloudquery/python-plugin-template#5 updates the template to better explain how to publish the docker image to the CloudQuery registry

Comment thread docs/README.md
@@ -0,0 +1,3 @@
# JavaScript Source Plugin Template
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

At least once doc file is needed for publishing to work

Comment thread package.json
"scripts": {
"dev": "ts-node --esm src/main.ts serve",
"build": "rm -rf dist && tsc",
"package:container": "docker build -t cq-js-sample:latest .",
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This was outdated, the JS SDK will run docker build instead

Comment thread src/plugin.ts
spec,
{ noConnection },
) => {
pluginClient.spec = parseSpec(spec);
Copy link
Copy Markdown
Member Author

@erezrokah erezrokah Jan 26, 2024

Choose a reason for hiding this comment

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

the package command and some others pass an empty spec and noConnection: true so we should skip parsing the spec and initializing the client for noConnection: true

@erezrokah erezrokah requested a review from pilvikala January 26, 2024 12:32
@erezrokah erezrokah added the automerge Add to automerge PRs once requirements are met label Jan 26, 2024
@erezrokah erezrokah enabled auto-merge (squash) January 26, 2024 12:32
@erezrokah erezrokah merged commit 8991932 into main Jan 26, 2024
@erezrokah erezrokah deleted the chore/add_publish_docs branch January 26, 2024 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automerge Add to automerge PRs once requirements are met

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants