Skip to content

docs: update README for Node-based build and automated releases#192

Merged
duncdrum merged 1 commit into
eXist-db:masterfrom
joewiz:docs/update-readme
May 27, 2026
Merged

docs: update README for Node-based build and automated releases#192
duncdrum merged 1 commit into
eXist-db:masterfrom
joewiz:docs/update-readme

Conversation

@joewiz
Copy link
Copy Markdown
Member

@joewiz joewiz commented May 27, 2026

[This response was co-authored with Claude Code. -Joe]

Closes #191.

The README still documented the old Maven flow after #183 landed. Updates:

  • Fix CI badge: the workflow file was renamed ci.ymlbuild.yml in feat!: de-mavenize the build #183, so the existing badge was 404ing on master
  • Replace Maven build instructions with the Node-based flow (`npm ci && npm run build`); call out `dist/exist-function-documentation-.xar` as the output path and `npm run develop` / `npm run deploy` for local iteration
  • Add a Release Procedure section explaining the semantic-release pipeline, the conventional-commit format expected from contributors, and what release managers need to do (nothing routine — pushes to master are released automatically)
  • Tidy installation + dependency wording

This was originally intended as part of #183 but didn't make it in before the merge — opening as a standalone follow-up.

- Update build instructions to Node.js / npm (the Maven flow was removed
  in eXist-db#183)
- Fix CI badge URL/name (workflow renamed ci.yml -> build.yml)
- Add Release Procedure section documenting the semantic-release flow,
  required conventional-commit format, and what contributors / release
  managers need to do
- Tidy installation and dependency wording

Closes eXist-db#191
@duncdrum duncdrum merged commit a491538 into eXist-db:master May 27, 2026
4 checks passed
@joewiz joewiz deleted the docs/update-readme branch May 27, 2026 13:00
@github-actions
Copy link
Copy Markdown

🎉 This PR is included in version 3.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

update readme

2 participants