Skip to content

docs(builder): add README documentation#430

Merged
jcbsfilho merged 3 commits into
mainfrom
feat/add-readme
Apr 23, 2026
Merged

docs(builder): add README documentation#430
jcbsfilho merged 3 commits into
mainfrom
feat/add-readme

Conversation

@jcbsfilho
Copy link
Copy Markdown
Collaborator

This pull request introduces a patch release for @aziontech/builder focused on improving documentation and package configuration. The most significant change is the addition of a comprehensive README.md to guide users in installing and using the builder utilities for Azion's platform. There are also minor adjustments to package metadata and workflow comments for clarity.

Documentation improvements:

  • Added a detailed README.md to packages/builder, covering installation, usage examples with esbuild and webpack, feature descriptions, polyfill usage, API reference, and contribution guidelines.
  • Updated the files array in packages/builder/package.json to include the new README.md in published files.

Release and workflow adjustments:

  • Added a patch changelog entry for @aziontech/builder noting the new README. (.changeset/huge-sheep-flash.md)
  • Commented out the NODE_AUTH_TOKEN line in .github/workflows/release.yml to clarify that it's only needed when publishing a new package.

Other package metadata:

  • Marked @aziontech/client as private in its package.json to prevent accidental publishing.

@jcbsfilho jcbsfilho requested a review from a team as a code owner April 23, 2026 23:15
@github-actions
Copy link
Copy Markdown
Contributor

SCC Complexity Analysis

  • Title: docs(builder): add README documentation
  • Author: jcbsfilho
Metric Source Branch (feat/add-readme) Target Branch (main) Difference
Complexity 2438 2438 0
Code 50050 49940 110

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 23, 2026

Open in StackBlitz

npm i https://pkg.pr.new/aziontech/lib/@aziontech/builder@430

commit: 63662c5

@jcbsfilho jcbsfilho merged commit 04aa395 into main Apr 23, 2026
10 checks passed
@jcbsfilho jcbsfilho deleted the feat/add-readme branch April 23, 2026 23:18
@pablodiehl pablodiehl mentioned this pull request Apr 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant