Skip to content

chore: autogenerate audit log documentation #5862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jan 26, 2023

Conversation

Kira-Pilot
Copy link
Member

@Kira-Pilot Kira-Pilot commented Jan 25, 2023

Resolves #5356
We now autogenerate the resource table in our Audit Log documentation:
https://coder.com/docs/v2/0facafef8f0ea6e3ba065a79993c622fb378f108/admin/audit-logs

@Kira-Pilot Kira-Pilot changed the title Autogenerate audit docs/kira pilot chore: autogenerate audit log documentation Jan 25, 2023
@Kira-Pilot Kira-Pilot marked this pull request as ready for review January 25, 2023 21:31
@Kira-Pilot
Copy link
Member Author

@kylecarbs The below check is failing. Shall I add an exception to scripts/check_enterprise_imports.sh for this import or move the script elsewhere?
Screen Shot 2023-01-25 at 3 47 14 PM

Copy link
Member

@mtojek mtojek left a comment

Choose a reason for hiding this comment

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

I found only minor issues, so we can merge it soon 👍

ERROR: AGPL code cannot import enterprise!

Yup, an exception would be enough. You can include it in this PR, Kira.

@Kira-Pilot Kira-Pilot merged commit e2bea2d into main Jan 26, 2023
@Kira-Pilot Kira-Pilot deleted the autogenerate-audit-docs/kira-pilot branch January 26, 2023 23:12
@github-actions github-actions bot locked and limited conversation to collaborators Jan 26, 2023
@@ -9,7 +9,7 @@ source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
cdroot

set +e
find . -regex ".*\.go" | grep -v "./enterprise" | xargs grep -n "github.com/coder/coder/enterprise"
find . -regex ".*\.go" | grep -v "./enterprise" | grep -v "./scripts/auditdocgen/main.go" | xargs grep -n "github.com/coder/coder/enterprise"
Copy link
Member

Choose a reason for hiding this comment

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

grep -v "./scripts/auditdocgen/*.go" - in case we add more .go files in the future.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good idea! I'll add this change in this PR.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

audit: autogenerate docs for all events that are audited
3 participants