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

Magefile updates #402

Closed
wants to merge 1 commit into from
Closed

Magefile updates #402

wants to merge 1 commit into from

Conversation

l50
Copy link
Contributor

@l50 l50 commented Oct 26, 2023

Summary: Refactored magefiles/magefile.go and updated documentation and tool versions for magefiles.

Added:

  • magefiles/README.md - New README for the magefiles directory detailing
    functions, usage examples, and contributing guidelines.
  • magefiles/tmpl/README.md.tmpl - Enhanced template for more descriptive
    README files for the magefiles package.
  • docgen.go - Extracted documentation generation logic from magefile.go.
  • testing.go - Segregated testing-related functions from magefile.go.

Changed:

  • .tool-versions - Updated Go to version 1.21.3 and Python to version 3.12.0.
  • magefiles/tmpl/README.md.tmpl - Adjusted for better magefiles package
    documentation structure.
  • magefile.go - Split code into multiple files for easier maintenance and
    better organization.
  • Patched older net library for enhanced security and performance.

Differential Revision: D50618372

@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D50618372

@TTPForge-bot TTPForge-bot added area/go Changes made to go resources area/mage labels Oct 26, 2023
@l50 l50 changed the title Patch, updates and refactor for improved magefiles upkeep and documentation. Magefile updates Oct 26, 2023
…entation. (facebookincubator#402)

Summary:

**Added:**

- `magefiles/README.md` - New README for the `magefiles` directory detailing
  functions, usage examples, and contributing guidelines.
- `magefiles/tmpl/README.md.tmpl` - Enhanced template for more descriptive
  README files for the `magefiles` package.
- `docgen.go` - Extracted documentation generation logic from `magefile.go`.
- `testing.go` - Segregated testing-related functions from `magefile.go`.

**Changed:**

- `.tool-versions` - Updated Go to version 1.21.3 and Python to version 3.12.0.
- `magefiles/tmpl/README.md.tmpl` - Adjusted for better `magefiles` package
  documentation structure.
- `magefile.go` - Split code into multiple files for easier maintenance and
  better organization.
- Patched older net library for enhanced security and performance.

Reviewed By: d3sch41n

Differential Revision: D50618372
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D50618372

@facebook-github-bot
Copy link
Contributor

This pull request has been merged in ad00b0d.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/go Changes made to go resources
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants