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

Add widget api #1503

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

Williangalvani
Copy link
Member

No description provided.

@Williangalvani Williangalvani force-pushed the widget_api branch 9 times, most recently from bc86de2 to 07b912b Compare December 17, 2024 16:48
@Williangalvani Williangalvani force-pushed the widget_api branch 11 times, most recently from e1d4e3c to cb52d94 Compare December 18, 2024 00:18
@Williangalvani Williangalvani changed the title [WIP] add widget api Add widget api Dec 18, 2024
@Williangalvani Williangalvani marked this pull request as ready for review December 18, 2024 00:19
{
echo '{
"name": "@bluerobotics/cockpit-api",
"version": "'${{ github.ref_name }}'",
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 think we should not use the cockpit version here. thoughts?

Copy link
Member

Choose a reason for hiding this comment

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

We shouldn't. Cockpit has new releases every week, while the API will probably be updated every few months.

@ES-Alexander ES-Alexander added the docs-needed Change needs to be documented label Dec 19, 2024
vite.config.ts Outdated Show resolved Hide resolved
Copy link
Member

@rafaellehmkuhl rafaellehmkuhl left a comment

Choose a reason for hiding this comment

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

I have put some comments here and there, but in general I really like the solution and loved that you added support for Ardupilot variables in the data-lake!

/**
* Current version of the Cockpit Widget API
*/
export const COCKPIT_WIDGET_API_VERSION = '0.0.0'
Copy link
Member

Choose a reason for hiding this comment

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

This should be injected in build time, right?

Copy link
Member Author

Choose a reason for hiding this comment

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

yes. where should the "source of truth" live, though?

Copy link
Member

Choose a reason for hiding this comment

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

Difficult.
If it was in its own repo, we could track the git release, but in this case we maybe have to hardcode it in the packages.json?

Copy link
Member Author

@Williangalvani Williangalvani Dec 19, 2024

Choose a reason for hiding this comment

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

idk. we need it in 3 places: packages.json, publish-lib.yml, and api.ts 🤔
is it easier to move from code to packages.json or from packages.json to code?

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'm thinking of leaving the source of truth on publish.yaml
then we can make it an environment variable for building, and use sed to inject it into packages.json.

I don't really like the idea, but I can't think of anything better. thoughts?

Copy link
Member

Choose a reason for hiding this comment

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

Sounds valid. Can't think of something better either.

src/libs/external-api/api.ts Outdated Show resolved Hide resolved
src/libs/vehicle/ardupilot/ardupilot.ts Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-needed Change needs to be documented
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants