🚧 This PR moves all of the published hzcore packages to the GitHub Packages registry.
Background
We have been publishing these packages privately, under an @hzcore namespace to our own npm registry. While this has worked out quite well, it is not without drawbacks. For example:
The private registry, while simple, is also brittle, and sometimes becomes unresponsive
The private registry does not receive regular maintenance of any sort, meaning it could become vulnerable to security issues over time
Using the private registry requires complicated authentication steps that frequently trip up development and CI cycles
GitHub now offers a package registry for use by any repositories it hosts. With this PR, we are looking to draw down our reliance on a self-hosted private registry by using the GitHub registry (that we are in some sense already paying for as part of our repository hosting agreement). However, this move is not without drawbacks:
packages published to the GitHub registry must be namespaced to the owner
using the GitHub registry requires similarly complicated authentication steps
Details
This PR does these major things:
renames all packages to the @hzdg namespace
removes hzcore- prefix from all package directories
configures all packages to publish to https://npm.pkg.github.com/ (the GitHub registry)
Todo
[x] move published hzcore packages to github registry
[x] @hzcore/dom-utils
[x] @hzcore/draftail-renderer
[x] @hzcore/focus-scope
[x] @hzcore/gesture-catcher
[x] @hzcore/gesture-observable
[x] @hzcore/hook-debounced-callback
[x] @hzcore/hook-hover
[x] @hzcore/hook-intersection
[x] @hzcore/hook-key-press
[x] @hzcore/hook-ratio-size
[x] @hzcore/hook-ref-callback
[x] @hzcore/hook-size
[x] @hzcore/hook-throttled-callback
[x] @hzcore/hook-value-object
[x] @hzcore/moving-average
[x] @hzcore/page-gesture
[x] @hzcore/resize-observable
[x] @hzcore/scroll-monitor
[x] @hzcore/windowsize-monitor
[x] move published goby packages to github registry
[x] @hzdg/gatsby-plugin-live-query
[x] @hzdg/gatsby-plugin-wagtail-headless
[x] @hzdg/gatsby-theme-wagtail-headless
[ ] move other published packages to github registry
[ ] @hzdg/hz-jam-cli (By: hzdg)
[ ] @ryanbagwell/react-renderhelper (By: Ryan Bagwell)
[ ] aws-setup (By: Ryan Bagwell)
[ ] gatsby-theme-halstead (By: ??? (Elaine?))
[ ] carlyle-common-js (By: Ryan Bagwell)
[ ] hz-gatsby-starter (By: Andrey Morozov)
[ ] hz-gatsby-themes (By: Andrey Morozov)
[ ] hz-new_relic (By: Andrey Morozov)
[ ] nightwatch-lib (By: Andrey Morozov)
[x] rename all hook- packages to use-not sure on this, but i like the idea of package names more precisely matching what they export
[ ] deprecate packages that we aren't planning to use/maintain any more:
[ ] @hzdg/scroll-monitor (should extract hooks from this package into their own packages)
[x] @hzdg/gesture-catcher
[ ] @hzdg/page-gesture
[ ] @hzdg/gatsby-plugin-wagtail-headless
[ ] write migration guide
[ ] local dev
[ ] project config
[ ] CI
[ ] make npmregistry.hzdg.com readonly
[ ] show deprecation message with link to migration guide on every read
🚧 This PR moves all of the published hzcore packages to the GitHub Packages registry.
Background
We have been publishing these packages privately, under an
@hzcore
namespace to our own npm registry. While this has worked out quite well, it is not without drawbacks. For example:GitHub now offers a package registry for use by any repositories it hosts. With this PR, we are looking to draw down our reliance on a self-hosted private registry by using the GitHub registry (that we are in some sense already paying for as part of our repository hosting agreement). However, this move is not without drawbacks:
Details
This PR does these major things:
@hzdg
namespacehzcore-
prefix from all package directorieshttps://npm.pkg.github.com/
(the GitHub registry)Todo
hook-
packages touse-
not sure on this, but i like the idea ofpackage names more precisely matching what they export