(AB-1951698) Add Changed Content Version Reporting #8931
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Docs Build status updates of commit 8c6a2b7: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 29e6ce7: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 716be78: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 8326eac: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
michaeltlombardi
force-pushed
the
ab-1951698/main/develop-vc-report-action
branch
from
8326eac to
079479c
Compare
|
Docs Build status updates of commit 079479c: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit a1fc139: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
michaeltlombardi
force-pushed
the
ab-1951698/main/develop-vc-report-action
branch
from
a1fc139 to
93aeeab
Compare
|
Docs Build status updates of commit 93aeeab: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
michaeltlombardi
force-pushed
the
ab-1951698/main/develop-vc-report-action
branch
from
93aeeab to
112c532
Compare
|
Docs Build status updates of commit 112c532: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
michaeltlombardi
force-pushed
the
ab-1951698/main/develop-vc-report-action
branch
from
112c532 to
9ac0239
Compare
|
Docs Build status updates of commit 9ac0239: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
When managing documentation with multiple versions of the same file, it is necessary to check Pull Requests modifying versioned content across all of the versions that file exists for. It is not always obvious from GitHub's view for files changed in a Pull Request whether and how a file was modified across versions. Prior to this change, the only way for the maintainers to inspect this information was to carefully read every change in the Pull Request. It required a large amount of cognitive load as a reviewer needed to make a mental note of every change to versioned content, find the other versions of that file (if any) the Pull Request modified, and verify whether all needed changes were made. This change helps to address the problem by introducing a new GitHub Action for reporting on how a Pull Request modified versioned content. The new `reporting/versioned-content` action inspects the files changed in a Pull Request to determine which files are versioned content and then writes a report by folder enumerating which files the Pull Request changed and how those changes impact each version for the file. The action is called in this repository by the new `versioned-content` workflow, which runs on Pull Requests to the `main` branch which modify versioned content in the `reference` folder. Like the other actions, `reporting/versioned-content` can be called from other repositories. This change also added new utility functions to the GHA module: - `Add-VersionedContentTable` writes a markdown table summarizing a changeset. - `Get-VersionedContentChangeStatus` analyzes a Pull Request's changes to return information about the changes to versioned content. - `Get-VersionedContentTableColumnWidth` returns the calculated widths for columns in the report's tables to ensure the pipes in the tables line up for reading when interactively debugging. All three functions are exported by the module. Finally, the action utilizes the updated `Get-VersionedContentReport` script, which is now appropriately documented. - Resolves AB#1951698
michaeltlombardi
force-pushed
the
ab-1951698/main/develop-vc-report-action
branch
from
9ac0239 to
375fdf0
Compare
|
Docs Build status updates of commit 375fdf0: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
When managing documentation with multiple versions of the same file, it is necessary to check Pull Requests modifying versioned content across all of the versions that file exists for. It is not always obvious from GitHub's view for files changed in a Pull Request whether and how a file was modified across versions.
Prior to this change, the only way for the maintainers to inspect this information was to carefully read every change in the Pull Request. It required a large amount of cognitive load as a reviewer needed to make a mental note of every change to versioned content, find the other versions of that file (if any) the Pull Request modified, and verify whether all needed changes were made.
This change helps to address the problem by introducing a new GitHub Action for reporting on how a Pull Request modified versioned content.
The new
reporting/versioned-contentaction inspects the files changed in a Pull Request to determine which files are versioned content and then writes a report by folder enumerating which files the Pull Request changed and how those changes impact each version for the file.The action is called in this repository by the new
versioned-contentworkflow, which runs on Pull Requests to themainbranch which modify versioned content in thereferencefolder.Like the other actions,
reporting/versioned-contentcan be called from other repositories.This change also added new utility functions to the GHA module:
Add-VersionedContentTablewrites a markdown table summarizing a changeset.Get-VersionedContentChangeStatusanalyzes a Pull Request's changes to return information about the changes to versioned content.Get-VersionedContentTableColumnWidthreturns the calculated widths for columns in the report's tables to ensure the pipes in the tables line up for reading when interactively debugging.All three functions are exported by the module.
Finally, the action utilizes the updated
Get-VersionedContentReportscript, which is now appropriately documented.Example Reports
PR Checklist