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

Versioning of packages and countdown js/css assets #53

Open
gadenbuie opened this issue Feb 5, 2024 · 1 comment
Open

Versioning of packages and countdown js/css assets #53

gadenbuie opened this issue Feb 5, 2024 · 1 comment
Labels
priority: high High priority status: planned Planning to implement type: maintenance Eat your vegetables

Comments

@gadenbuie
Copy link
Owner

We have a number of different versions to consider:

  • The R package version
  • The Quarto extension version
  • The Python package version
  • The countdown JS/CSS assets version in lib/
  • The countdown JS/CSS assets in each package

It would be helpful to have a method for versioning each of these items. My proposal:

  1. Package and extension code is versioned independently of the core countdown assets
    • These version should agree in the minor element, e.g. 0.2.x of any package/extension code should implement the same behaviors.
    • Patch versions increment with local changes to the package/extension code
  2. The core countdown assets maintain their own version number that is used by the html dependency.

We can add a header to lib/countdown.js that tracks its version number, which can be read by the package code or used in the update process when updating the extension.

@coatless
Copy link
Collaborator

coatless commented Feb 6, 2024

I think the plan surrounding independent versioning is spot-on. Though, we may want to add one more decimal point. (If only R supported semantic versioning with x.y.z-a.1; but alas we're stuck with x.y.z.a.1).

Could we offload writing versions into a config.R/config.py file? That would make it easier to track the embedded version without introducing a diff that might detract from library changes.

e.g.

/* countdown: 0.1.1 */

.countdown {
  /* CSS */
}
echo "countdown_embedded <- '${COUNTDOWN_ASSET_VERSION}'" >> config.R

This would generate:
config.R

countdown_embedded <- '0.1.1'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: high High priority status: planned Planning to implement type: maintenance Eat your vegetables
Projects
None yet
Development

No branches or pull requests

2 participants