Skip to content

Commit 2a8f690

Browse files
authored
fix: Python Remote File Source did not have correct repository (#1265)
- Need to set the repository correctly for it to publish - Also needed to add the tag to the modified-plugin workflow, and update the README with that
1 parent 07b35ea commit 2a8f690

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

.github/workflows/modified-plugin.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ on:
1717
- 'utilities-v*'
1818
- 'packaging-v*'
1919
- 'theme-pack-v*'
20+
- 'python-remote-file-source-v*'
2021

2122
jobs:
2223
changes:

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -375,14 +375,21 @@ If you've added a new plugin to the `plugins/` directory, there are a couple thi
375375
1. Add an entry for the new plugin in `cog.toml` under the `[package]` section. Use the existing entries as examples.
376376
2. Update the `tools/update_version.sh` script to include the new plugin and where its version is stored in source code. If your component has both a Python and JS component, you'll need to add it to both sections. Use the existing entries as examples.
377377
- For an example, check the [PR that added the pivot plugin for release](https://github.com/deephaven/deephaven-plugins/pull/1242/files).
378-
3. In PyPI, Add a new pending publisher for the project.
378+
3. Add the new plugin to the `.github/workflows/modified-plugin.yml` file so that a tag pushed with the name of the plugin will trigger the modified plugin workflow.
379+
4. In PyPI, Add a new pending publisher for the project.
379380
1. Go to https://pypi.org/manage/account/publishing/
380381
2. Under "Add a new pending publisher" section, enter the following:
381382
- PyPI Project Name: The name of the python plugin, e.g. `deephaven-plugin-ui`
382383
- Owner: `deephaven`
383384
- Repository name: `deephaven-plugins`
384385
3. Click "Add"
385-
4. For npmjs, the project should already be scoped to the `@deephaven` or `@deephaven-enterprise` organization, and you should not need to do anything extra.
386+
5. For npmjs, the project should already be scoped to the `@deephaven` or `@deephaven-enterprise` organization. You may need to update the `package.json` to include the correct `repository` if it is not already set. Add the following to your `package.json`:
387+
```json
388+
"repository": {
389+
"type": "git",
390+
"url": "git+https://github.com/deephaven/deephaven-plugins.git"
391+
}
392+
```
386393
387394
After completing the above, you should be able to run the release script in the [Cutting a New Release](#cutting-a-new-release) section. After the first release, verify that the version numbers are being updated correctly in source code, and that the releases are being created correctly on GitHub, PyPI, and npmjs. You should also update the project and add `deephaven` as an owner on the project in PyPI.
388395

plugins/python-remote-file-source/src/js/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
"author": "deephaven",
1010
"license": "Apache-2.0",
1111
"main": "dist/index.js",
12+
"repository": {
13+
"type": "git",
14+
"url": "git+https://github.com/deephaven/deephaven-plugins"
15+
},
1216
"scripts": {
1317
"start": "vite build --watch",
1418
"build": "vite build"

0 commit comments

Comments
 (0)