jquery / jquery/infrastructure-puppet
Upgrade Typesense from 28.0 to 30.x
Nobody has claimed this yet.
- Dominant language
- Puppet
- Stars
- 12
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Previously https://github.com/jquery/infrastructure-puppet/issues/36.
No rush at the moment, but figured I'd write this up while I still have the previous one fresh in mind.
- Check release notes at https://github.com/typesense/typesense/releases:
- Look for deprecations or breaking changes that affect any of these repos:
- Look for upgrades that raise our downgrade floor. Typsense allows upgrades past many versions at once, but, we'll want to upgrade in steps to pause at any versions before any version that raises the downgrade potential, so that we don't upgrade to a version we can't downgrade back down from.
- If changes are needed in typesense-minibar:
- Propose the changes and wait for code review
- Publish typesense-minibar release
- Update copy in jquery-wp-content
- Update copy in jekyll-theme-amethyst (and tag release here, and apply to qunitjs/qunit:/docs
- To perform each upgrade:
- create/edit the node-specific Hieradata (example)
- run
sudo run-puppet-agenton the host - run
sudo systemctl restart typesense-serveron the host - Test suggestions at https://jquery.com and https://qunitjs.com
- If we've upgraded to a version that requires a newer docsearch-scraper: https://github.com/typesense/typesense-docsearch-scraper/
- Update docsearch-scraper everywhere:
- https://github.com/search?q=org%3Ajquery+typesense%2Fdocsearch-scraper&type=code
- https://github.com/search?q=org%3Aqunitjs+typesense%2Fdocsearch-scraper&type=code
- https://github.com/search?q=org%3Ajquery+path%3Adocsearch.config.json&type=code
- https://github.com/search?q=org%3Aqunitjs+path%3Adocsearch.config.json&type=code
- Kick off the workflows to re-index the site.
- Test suggestions at https://jquery.com and https://qunitjs.com
- Update docsearch-scraper everywhere:
- Clean up
- Change the default profile::typesense::version to match, and and remove redundant node-specific Hieradata override.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Typesense release notes, the linked infrastructure-puppet Hieradata example, and modules/profile/manifests/typesense.pp. Check the listed dependent repositories for breaking changes, downgrade constraints, and docsearch-scraper requirements before planning staged upgrades. Done means the upgrades, dependent releases or updates, re-indexing, suggestion tests, and default-version cleanup are completed.
Written by the indexing model from the issue text.
Assessment
- Domain
- infrastructure, search
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100