Skip to content

[DOC] Update README with snapshot instructions #223

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+44 −0
Open

[DOC] Update README with snapshot instructions #223

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,47 @@ Then in [`perses`](https://github.com/perses/perses) repository:
2. Start the backend: `./scripts/api_backend_dev.sh`
3. Login percli to the backend `percli login http://localhost:8080`
4. Start the plugin development server: `percli plugin start /path/to/the/plugin/dir`

### Working with Snapshots

This will allow you to use the updates from perses core in your plugin so you can test the changes.

1. In perses/perses create a [snapshot](https://github.com/perses/perses/blob/30758a963337564ab58c78646a1134e51d74e146/RELEASE.md?plain=1#L109-L146). Snapshots will be released in npm:
- https://www.npmjs.com/package/@perses-dev/components/
- https://www.npmjs.com/package/@perses-dev/core
- https://www.npmjs.com/package/@perses-dev/plugin-system
- https://www.npmjs.com/package/@perses-dev/dashboards
- https://www.npmjs.com/package/@perses-dev/explore

2. Copy the name of your snapshot, for exampale `v0.0.0-snapshot-panel-actions-520389b`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
2. Copy the name of your snapshot, for exampale `v0.0.0-snapshot-panel-actions-520389b`.
2. Copy the name of your snapshot, for example `v0.0.0-snapshot-panel-actions-520389b`.


3. In perses/plugin, navigate to the plugin you are changing and install the snapshot npm packages, this should be installed as "dependencies" NOT "peerDependencies" for example:

```
# perses/plugins/timeserieschart/package.json

"dependencies": {
"color-hash": "^2.0.2"
+ "@perses-dev/components": "v0.0.0-snapshot-panel-actions-520389b",
+ "@perses-dev/core": "v0.0.0-snapshot-panel-actions-520389b",
+ "@perses-dev/plugin-system": "v0.0.0-snapshot-panel-actions-520389b"
},
"peerDependencies": {
"@emotion/react": "^11.7.1",
"@emotion/styled": "^11.6.0",
"@hookform/resolvers": "^3.2.0",
- "@perses-dev/components": "^0.51.0-rc.1",
- "@perses-dev/core": "^0.51.0-rc.1",
- "@perses-dev/plugin-system": "^0.51.0-rc.1",
"date-fns": "^4.1.0",
"date-fns-tz": "^3.2.0",
"echarts": "5.5.0",
"lodash": "^4.17.21",
"react": "^17.0.2 || ^18.0.0",
"react-dom": "^17.0.2 || ^18.0.0",
"use-resize-observer": "^9.0.0",
"immer": "^10.1.1"
}
```

4. Then run `npm install` on the plugin folder to update the dependencies of your plugin (e.g., `cd perses/plugins/timeserieschart && npm install`).