Skip to content

Add bates number params to AL Document#1004

Merged
BryceStevenWilley merged 2 commits intomainfrom
bates_number_to_aldoc
Mar 19, 2026
Merged

Add bates number params to AL Document#1004
BryceStevenWilley merged 2 commits intomainfrom
bates_number_to_aldoc

Conversation

@BryceStevenWilley
Copy link
Copy Markdown
Contributor

Lets the ALDocumentBundle use bates_number function when generating a PDF, as well as the work-in-progress params.

Depends on jhpyle/docassemble#898

Copy link
Copy Markdown
Member

@nonprofittechy nonprofittechy left a comment

Choose a reason for hiding this comment

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

LGTM!

@nonprofittechy
Copy link
Copy Markdown
Member

@BryceStevenWilley let me know when this is really ready to review/merge--looks like you still made recent changes

@BryceStevenWilley
Copy link
Copy Markdown
Contributor Author

I had been waiting for jhpyle/docassemble#898 to be merged, but missed that it just got cherry-picked and is already in 1.9.2. Needs some testing there, but it shouldn't have to change much.

@nonprofittechy nonprofittechy marked this pull request as draft February 23, 2026 16:00
@nonprofittechy
Copy link
Copy Markdown
Member

Changing to draft--update state when it's ready to merge, and we can do a major version bump if we need if this depends on a specific Docassemble release

@BryceStevenWilley BryceStevenWilley marked this pull request as ready for review March 5, 2026 16:11
@BryceStevenWilley
Copy link
Copy Markdown
Contributor Author

Okay, finished testing again, there were some bug fixes that didn't make it into Docassemble that I made another PR for at jhpyle/docassemble#914, but whether that's in doesn't affect this PR (bates_number() will just be broken for normal docassemble users until that's merged).

It does still require docassemble 1.9.2, so it might be worth the major version bump.

@BryceStevenWilley
Copy link
Copy Markdown
Contributor Author

Additional discovery; ALExhibitDocument will error in Docassemble 1.9.2, as it partially uses the bates numbering stuff. We're only on 1.9.1 for our prod server, so I'm going to add a fix for ALExhibitDocument (working on it right now) to this PR, and then we'll have to merge / upgrade when we upgrade to 1.9.2.

@BryceStevenWilley BryceStevenWilley marked this pull request as draft March 5, 2026 19:39
@BryceStevenWilley
Copy link
Copy Markdown
Contributor Author

Switching back to draft, since I realized that this will break all existing interviews that don't start from the beginning.

@BryceStevenWilley BryceStevenWilley force-pushed the bates_number_to_aldoc branch 3 times, most recently from cd66bc0 to a2a5643 Compare March 5, 2026 20:53
@BryceStevenWilley BryceStevenWilley marked this pull request as ready for review March 5, 2026 22:23
@BryceStevenWilley
Copy link
Copy Markdown
Contributor Author

Forgot to comment back here, but fixed the remaining issues that I had found with the ALDocument (mainly being able to run with previously created objects. Should be ready for a re-review.

@ekressmiller
Copy link
Copy Markdown

Thanks so much for working on this! We're hoping to go live with the divorce tool that uses this change next week or the following week if possible.

Must be given to the `using` object block, and it sets
a param on the ALDocumentBundle object that gets used
when `as_pdf` is called. Addds defaults for all as well.
Passes along all of the bates parameters through all of the exhibit
document classes (ALExhibitDocument, ALExhibitList, ALExhibit).
@BryceStevenWilley
Copy link
Copy Markdown
Contributor Author

It does still require docassemble 1.9.2, so it might be worth the major version bump.

Realized that even though this does use docassemble 1.9.2 features / kwargs, it just silently drops the extra ones not used in lower versions of docassemble and doesn't error (tested this fact locally on 1.9.1). So I think is safe to merge / release without any version bumps in the AssemblyLine package.

@nonprofittechy, tagging you one more time if you want to review, I'll merge EOD today

Copy link
Copy Markdown
Member

@nonprofittechy nonprofittechy left a comment

Choose a reason for hiding this comment

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

Thanks, yes, this looks good to merge. Might still justify a major version bump in my opinion even if it won't literally break, since the new feature has a minimum version requirement. But I'm not expert on semver so open to your different interpretation.

@BryceStevenWilley
Copy link
Copy Markdown
Contributor Author

To me breaking things is the key part of a major version bump. Definitely should be a minor version bump, and it's just a little more involved configuration than normal (agreed semver gets weird for libraries that can run different features on different versions of the base software though, it's not really made for that).

@BryceStevenWilley BryceStevenWilley merged commit 3b4f64d into main Mar 19, 2026
9 checks passed
@BryceStevenWilley BryceStevenWilley deleted the bates_number_to_aldoc branch March 19, 2026 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants