Skip to content

Version update automation - #110

Open
kthoms wants to merge 16 commits into
mainfrom
version-update
Open

Version update automation#110
kthoms wants to merge 16 commits into
mainfrom
version-update

Conversation

@kthoms

@kthoms kthoms commented May 31, 2026

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI review requested due to automatic review settings May 31, 2026 20:03

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR introduces automation to keep documentation version references up to date by consolidating existing maintenance scripts into a single updater, wiring it into the scheduled maintenance workflow, and applying the resulting version bumps across multiple docs pages.

Changes:

  • Add .devenv/scripts/update_versions.py to update version references across active docs and then refresh Spring Boot/Quarkus compatibility tables.
  • Update the Maintenance GitHub Actions workflow to run the unified updater.
  • Bump various Operaton and third-party dependency versions in documentation snippets/links.

Reviewed changes

Copilot reviewed 12 out of 18 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
docs/get-started/spring-boot/project-setup.md Bumps referenced Operaton version in Spring Boot setup snippet.
docs/get-started/quick-start/service-task.md Updates dependency versions in the external task client quick-start snippet.
docs/get-started/dmn/project-setup.md Updates Operaton and build/dependency versions in DMN project setup snippet.
docs/get-started/apache-maven.md Updates BOM versions referenced in Maven guidance.
docs/documentation/user-guide/testing/index.md Updates GitHub link to Operaton Assert to the newer tag.
docs/documentation/user-guide/task-forms/jsf-task-forms.md Updates Bootstrap WebJar version used in the JSF forms styling section.
docs/documentation/user-guide/logging.md Updates Logback version in logging guidance.
.gitignore Ignores local docs/superpowers/ directory.
.github/workflows/maintenance.yml Renames/updates job to run the unified version updater and adjust commit message.
.devenv/scripts/update-spring-boot-version-table.py Refactors entrypoint to expose run() for orchestration.
.devenv/scripts/update-quarkus-version-table.py Refactors entrypoint to expose run() for orchestration.
.devenv/scripts/update_versions.py New unified script: resolves versions via SBOM/Maven Central, updates docs, then runs compatibility table updaters.
.devenv/scripts/tests/test_update_versions.py Adds unit tests covering release tag parsing, SBOM lookup, Maven fallback, and archive skipping.
.devenv/scripts/tests/init.py Initializes test package.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/documentation/user-guide/task-forms/jsf-task-forms.md
Comment thread .devenv/scripts/update_versions.py Outdated
Comment thread .devenv/scripts/update_versions.py
Comment thread .devenv/scripts/update_versions.py
Comment thread .devenv/scripts/update_versions.py
Comment thread docs/get-started/quick-start/service-task.md
Comment thread docs/get-started/dmn/project-setup.md
kthoms and others added 16 commits September 6, 2026 12:05
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…clusion

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Alpha, beta, RC, and milestone versions are excluded via regex filter.
Fetches 20 candidates from the GAV core and returns the first stable release.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ease regex, fix docstring, fix Bootstrap webjar path

Untrack .pyc files (Copilot didn't flag this, requested separately):
- .devenv/scripts/__pycache__/update-quarkus-version-table.cpython-311.pyc
- .devenv/scripts/__pycache__/update-spring-boot-version-table.cpython-311.pyc
These re-appeared in the "docs: update version references" automation
commit despite .gitignore already excluding __pycache__/ - adding a
gitignore entry doesn't untrack already-committed files.

Fix _PRE_RELEASE_RE to catch hyphen-separated qualifiers (Copilot,
update_versions.py:181): "4.0.0-beta-4" (maven-compiler-plugin's actual
prerelease scheme) wasn't matched by the old alpha\d*|beta\d*|rc\d*|m\d+
pattern, which only handled qualifiers with digits attached directly
(e.g. "2.1.0-alpha1"). Added a regression test.

Fix already-committed prerelease versions that slipped through before
this regex existed (Copilot, service-task.md:135 and
dmn/project-setup.md:91):
- slf4j-simple 2.1.0-alpha1 -> 2.0.17 (current stable)
- maven-compiler-plugin 4.0.0-beta-4 -> 3.15.0 (current stable)
Also restored two unrelated version bumps from the same commit that a
naive conflict resolution during the rebase onto current main had
accidentally reverted to their pre-PR values:
- javax.servlet-api -> 4.0.1
- maven-war-plugin -> 3.5.1

Fix docstring usage example (Copilot, update_versions.py:16): referenced
"update-versions.py" (hyphen), the file is "update_versions.py"
(underscore).

Fix Bootstrap webjar resource path (Copilot, jsf-task-forms.md:249): the
dependency was bumped to 5.3.7 but the JSF <h:outputStylesheet>/
<h:outputScript> library paths still pointed at webjars/bootstrap/3.1.1/,
which doesn't exist for that version.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants