Adding option to split MD documentation per policy

[snodecoder]

Currently there only is an option to split the generated MD documentation per type (Device Categories, Device Configurations..).

In my case this results in a massive MD file for Device Configurations consisting of all my policies. It would really useful in my view to support an additional split per policy. So that you get a top index.md with references to all the types, and then for each type again a [type].md file with references to it's children (in the case of Device Configurations it would contain a reference to separate underlying [policy].md files.

[almenscorner]

I have started testing this and aim to include it in beta 3 of 2.4.0 for public testing

[almenscorner]

This is included in the latest beta, to install run pip3 install IntuneCD==2.4.0b3.

From the release notes,

"A new argument --split-per-config has been added to documentation to allow for splitting the docs further by each config to their own MD doc. When set, documents each config in /docs in the config path, creates an index in the config path with the files and an additional index in the root for easy access."

[almenscorner]

Let me know how you get on and if there's anything else that needs fixing in 2.4.0 😄

[snodecoder]

Thanks! I will check it one more time to be sure but it seemed to work perfectly this way.

I was wondering though what the purpose is of the archive folder. Jsons are moved to the archive folder if they are deleted, but since the whole setup is built around using git for version control this does not seem necessary to me. Is there a reason that you've chosen for this approach?

[almenscorner]

Some might not be running the solution in Git and if nothing else it's just a convenience thing to be able to quickly check all configs that has been removed on a given date

[almenscorner]

Could arguably be an option to be able to turn it off

[snodecoder]

I would leave it in place i think, was just wondering ;)

[snodecoder]

Running 2.4.0b4
I have 2 more findings which are not blocking but maybe good for you to know. As far as I can see they do not have any impact for me.

Backup fails to connect to this endpoint (could be just because I do not have it configured in Intune)

Wed Mar 19 13:55:01 2025 [INFO] Request failed with status 404, response: {"error":{"code":"ResourceNotFound","message":"{\r\n  \"_version\": 3,\r\n  \"Message\": \"An error has occurred - Operation ID (for customer support): 00000000-0000-0000-0000-000000000000 - Activity ID: bc5c36e0-385d-4ad0-a74d-d7377855afe1 - Url: https://fef.msub07.manage.microsoft.com/DeviceFE/StatelessDeviceFEService/deviceManagement/applePushNotificationCertificate?api-version=5024-07-19\",\r\n  \"CustomApiErrorPhrase\": \"\",\r\n  \"RetryAfter\": null,\r\n  \"ErrorSourceService\": \"\",\r\n  \"HttpHeaders\": \"{}\"\r\n}","innerError":{"date":"2025-03-19T12:55:01","request-id":"bc5c36e0-385d-4ad0-a74d-d7377855afe1","client-request-id":"bc5c36e0-385d-4ad0-a74d-d7377855afe1"}}}
Wed Mar 19 13:55:01 2025 [ERROR] Error getting APNs data from https://graph.microsoft.com/beta/deviceManagement/applePushNotificationCertificate: Request failed after 5 retries with no response - no response

And I see a bunch of these in between backing up Proactive Remediations and Applications

Wed Mar 19 13:55:22 2025 [INFO] Hit Graph throttling (429), retrying in 20 seconds
Wed Mar 19 13:55:23 2025 [WARNING] Retry-After 'None' is not an integer, using exponential backoff
Wed Mar 19 13:55:23 2025 [INFO] Hit Graph throttling (429), retrying in 20 seconds
Wed Mar 19 13:55:39 2025 [WARNING] Retry-After 'None' is not an integer, using exponential backoff
Wed Mar 19 13:55:39 2025 [INFO] Hit Graph throttling (429), retrying in 40 seconds
Wed Mar 19 13:55:40 2025 [WARNING] Retry-After 'None' is not an integer, using exponential backoff
Wed Mar 19 13:55:40 2025 [INFO] Hit Graph throttling (429), retrying in 40 seconds
Wed Mar 19 13:55:41 2025 [WARNING] Retry-After 'None' is not an integer, using exponential backoff
Wed Mar 19 13:55:41 2025 [INFO] Hit Graph throttling (429), retrying in 40 seconds

[almenscorner]

If I were to guess you want activityType in the commit

[snodecoder]

Yep, I've added my changes here main...snodecoder:IntuneCD:main

[snodecoder]

this results in these commits.


instead of this (which implies that the entire policy was deleted instead of just the policy assignment)

I think the activityType better reflects the audit message then the current settings, what do you think?

[almenscorner]

I like it! create a PR to merge into dev :)

[snodecoder]

#224
Let me know if it's in order or if I need to change anything, I'm fairly new in the process of contributing to other projects 😅