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

Update prez-ui version on release #128

Open
edmondchuc opened this issue Dec 8, 2023 · 1 comment
Open

Update prez-ui version on release #128

edmondchuc opened this issue Dec 8, 2023 · 1 comment
Assignees

Comments

@edmondchuc
Copy link
Collaborator

This issue was copied from this issue in a private GitHub project board.

After looking into this and the existing solutions used in other public projects on GitHub, the best way forward is probably to trigger a GitHub Action that takes 1 input, version. The Action will then perform the following steps:

  • Update the package.json or pyproject.toml file with the value from version and commit to the main branch of the repo
  • Create a git tag on the last commit
  • Push the commit and tag to the repo

At this point, we can manually make a release using GitHub Releases as usual, generate the release notes and assign the release to the git tag that the Action just created.

See https://github.com/RDFLib/VocExcel/tree/master/.github/workflows for the proposed solution in action.

This will support the two primary ways we distribute Prez UI.

  1. Via a container image (container image is tagged with the version from the git tag at build time)
  2. As static build (version is added to package.json on pre-release step via GitHub Workflow trigger to create a git tag)

A follow-up to this task if all goes well is to align how we perform releases in the Prez API project. If we follow the same release process, we can ensure the pyproject.toml version is up to date on each release.

@edmondchuc
Copy link
Collaborator Author

This has been tagged with high priority as it's becoming increasingly hard to debug issues with clients using Prez and Prez UI. If we always know exactly which version they are running, it'll make the debugging issues much easier and less time consuming.

@edmondchuc edmondchuc moved this to 🆕 New in Prez Board Dec 8, 2023
@edmondchuc edmondchuc moved this from 🆕 New to 🔖 Todo in Prez Board Dec 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🔖 Todo
Development

No branches or pull requests

1 participant