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.

Sign up for GitHub

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

Jump to bottom

docs: improve contributing experience when generating bundles #666

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: improve contributing experience when generating bundles #666

wants to merge 1 commit into from

Conversation

alestiago
Copy link
Contributor

Status

READY

Description

Changes:

  • Swaps generating bundle steps in CONTRIBUTING.md
  • Included generate_local_bundles.sh to use the local bricks instead of git

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore

@alestiago alestiago changed the title docs: improve contributing experience docs: improve contributing experience when generating bundles May 25, 2023
@alestiago alestiago self-assigned this May 25, 2023
@alestiago alestiago added the documentation Improvements or additions to documentation label May 25, 2023
renancaraujo
renancaraujo reviewed May 25, 2023
View reviewed changes
tool/generate_local_bundles.sh
@@ -0,0 +1,16 @@
#!/bin/bash
# Runs `mason bundle` to generate bundles for all bricks within the top level bricks directory.
Copy link
Contributor

Choose a reason for hiding this comment

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

Avoid to generate bundles locally because felangel/mason#781

@alestiago alestiago marked this pull request as draft July 18, 2023 21:46
@alestiago
Copy link
Contributor Author

See #881

@erickzanardo
Copy link
Contributor

@alestiago anything blocking this PR?

renancaraujo
renancaraujo suggested changes Aug 28, 2023
View reviewed changes
Copy link
Contributor

@renancaraujo renancaraujo left a comment

Choose a reason for hiding this comment

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

We should now commit locally generated bundles because the mason bundle doesn't discriminate git ignored files. Resulting on bundles with undesired files, suck as pubspec.lock and others. See the previously linked mason issue.

@alestiago
Copy link
Contributor Author

alestiago commented Aug 29, 2023 •
edited
Loading

I'm happy to close this Pull Request or let it be until mason resolves the issue.

Either way I think we should consider updating the CONTRIBUTING.md with:

  • A recommended way to debug and test the CLI when changing the templates
  • Information about updating the bundles for a release
  • Modify the previous information about using tool/generate_bundles.sh

@tomarra
Copy link
Contributor

tomarra commented Feb 7, 2024

Need to get felangel/mason#1227 in and deployed before going back to this work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@renancaraujo renancaraujo renancaraujo requested changes

@erickzanardo erickzanardo erickzanardo approved these changes

@felangel felangel Awaiting requested review from felangel

@wolfenrain wolfenrain Awaiting requested review from wolfenrain

At least 1 approving review is required to merge this pull request.

Assignees

@alestiago alestiago

Labels
documentation Improvements or additions to documentation
Projects
VGV Open Source 🦄 🧙🌟
Status: Needs Triage
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@alestiago @erickzanardo @tomarra @renancaraujo