Skip to content
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

chore: separate docs:generate #4242

Merged
merged 1 commit into from
May 10, 2023
Merged

Conversation

knqyf263
Copy link
Collaborator

@knqyf263 knqyf263 commented May 9, 2023

Description

The mage command is quite slow now since it imports github.com/aquasecurity/trivy to generate docs. Mage tries to compile magefiles/magefile.go, then also compiles the trivy packages. All other targets, such as mage fmt and mage lint, don't need the trivy packages, and they should be fast.

This PR separates mage docs:generate into a different file with a custom tag so that other targets will not import Trivy.

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

@knqyf263 knqyf263 self-assigned this May 9, 2023
@knqyf263 knqyf263 marked this pull request as ready for review May 9, 2023 19:25
@knqyf263 knqyf263 requested a review from DmitriyLewen May 9, 2023 19:26
@knqyf263 knqyf263 merged commit ec3906c into aquasecurity:main May 10, 2023
8 checks passed
@knqyf263 knqyf263 deleted the separate_docs_gen branch May 10, 2023 06:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants