Skip to content

Update examples to 2.6#503

Merged
JieXiong9119 merged 4 commits intodevelop-v2from
feat/update-examples-to-2.6
Sep 30, 2024
Merged

Update examples to 2.6#503
JieXiong9119 merged 4 commits intodevelop-v2from
feat/update-examples-to-2.6

Conversation

@JieXiong9119
Copy link
Copy Markdown
Contributor

Any background context you want to provide?

What does this PR do?

Update examples and docs to referencing BuildingSync 2.6

How should this be manually tested?

What are the relevant tickets?

Screenshots (if appropriate)

@JieXiong9119 JieXiong9119 added Non-breaking Change Schema: Documentation Update to BuildingSync's documentation/annotations labels Sep 27, 2024
@JieXiong9119 JieXiong9119 self-assigned this Sep 27, 2024
@markborkum
Copy link
Copy Markdown
Contributor

@JieXiong9119, Please revert the changes to the 3 "AT_" example files. While the updated files in this pull request are syntactically and structurally valid, if this pull request were merged, then the presence of the updated files in this repository could give users the false impression that the Audit Template tool currently supports version 2.6.0.

@markborkum
Copy link
Copy Markdown
Contributor

@JieXiong9119, Thanks for the quick response. Currently, the Audit Template tool supports version 2.4.0 (not 2.5.0).

@JieXiong9119
Copy link
Copy Markdown
Contributor Author

@JieXiong9119, Thanks for the quick response. Currently, the Audit Template tool supports version 2.4.0 (not 2.5.0).

I see. Do we have any plan in FY25 to support the newest version? I think 2.5 introduce a lot of changes and 2.6 includes the request of AuditCycleStartDate and EndDate.``

@JieXiong9119
Copy link
Copy Markdown
Contributor Author

@markborkum Reverting the version to 2.4 might introduce check fails due to the UsefulLife element type error

@markborkum
Copy link
Copy Markdown
Contributor

@JieXiong9119, Thanks for the quick response. Currently, the Audit Template tool supports version 2.4.0 (not 2.5.0).

I see. Do we have any plan in FY25 to support the newest version? I think 2.5 introduce a lot of changes and 2.6 includes the request of AuditCycleStartDate and EndDate.``

We do. I met with @ThibaultMarzullo and @nllong yesterday to discuss the details. The Audit Template tool will upgrade to the most recent version of the schema in 2025.

@JieXiong9119
Copy link
Copy Markdown
Contributor Author

@JieXiong9119, Thanks for the quick response. Currently, the Audit Template tool supports version 2.4.0 (not 2.5.0).

I see. Do we have any plan in FY25 to support the newest version? I think 2.5 introduce a lot of changes and 2.6 includes the request of AuditCycleStartDate and EndDate.``

We do. I met with @ThibaultMarzullo and @nllong yesterday to discuss the details. The Audit Template tool will upgrade to the most recent version of the schema in 2025.

Cool! I'd like keep the version as 2.5 as they were in case failing the checks. Does it work?

@markborkum
Copy link
Copy Markdown
Contributor

@JieXiong9119, Thanks for the quick response. Currently, the Audit Template tool supports version 2.4.0 (not 2.5.0).

I see. Do we have any plan in FY25 to support the newest version? I think 2.5 introduce a lot of changes and 2.6 includes the request of AuditCycleStartDate and EndDate.``

We do. I met with @ThibaultMarzullo and @nllong yesterday to discuss the details. The Audit Template tool will upgrade to the most recent version of the schema in 2025.

Cool! I'd like keep the version as 2.5 as they were in case failing the checks. Does it work?

I guess. Could we add XML comments to the files that acknowledges that the version in the file is 2.5.0, but Audit Template currently supports version 2.4.0?

@JieXiong9119
Copy link
Copy Markdown
Contributor Author

@JieXiong9119, Thanks for the quick response. Currently, the Audit Template tool supports version 2.4.0 (not 2.5.0).

I see. Do we have any plan in FY25 to support the newest version? I think 2.5 introduce a lot of changes and 2.6 includes the request of AuditCycleStartDate and EndDate.``

We do. I met with @ThibaultMarzullo and @nllong yesterday to discuss the details. The Audit Template tool will upgrade to the most recent version of the schema in 2025.

Cool! I'd like keep the version as 2.5 as they were in case failing the checks. Does it work?

I guess. Could we add XML comments to the files that acknowledges that the version in the file is 2.5.0, but Audit Template currently supports version 2.4.0?

I'll use 2.6 then to keep consistency with all examples. I added notes to indicate AT supports 2.4 now, and the notes will be removed once AT supports 2.6.

Copy link
Copy Markdown
Contributor

@markborkum markborkum left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thanks, @JieXiong9119!

Copy link
Copy Markdown
Contributor

@ThibaultMarzullo ThibaultMarzullo left a comment

Choose a reason for hiding this comment

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

Thanks Jie! One minor comment on the release instructions.

Comment thread docs/release_instructions.md Outdated
Co-authored-by: ThibaultMarzullo <56871007+ThibaultMarzullo@users.noreply.github.com>
@JieXiong9119 JieXiong9119 merged commit 41fd2d7 into develop-v2 Sep 30, 2024
@JieXiong9119 JieXiong9119 deleted the feat/update-examples-to-2.6 branch September 30, 2024 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Non-breaking Change Schema: Documentation Update to BuildingSync's documentation/annotations

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants