Skip to content

Explain what happens with repeated or failed pkg compilation #192

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

Open
6 tasks
greenbreakfast opened this issue Jan 29, 2025 · 1 comment
Open
6 tasks
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@greenbreakfast
Copy link
Contributor

Motivation

Why are we doing this? What use cases does it support? What problems does it solve? What is the expected outcome?

Feedback from @crispyoz 's comment on Create a Custom Package article

Want to better describe what happens if a package fails compilation, and how to handle changing package source and compiling again

Is your documentation request related to a problem? Please describe.

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

More clarity is needed on 1) updating feeds - when, why, and how, 2) how to handle a failed package compilation

Describe the solution you'd like

A clear and concise description of what you want to happen.

Updates to Compile a Package article:

  • Add a new section on failed compilation
    • explain the sdk wrapper will automatically rerun the package compile command with max verbosity to make it easy to debug the problem
    • explain how to rerun compilation after a code change (fix) has been made
  • Add a new section on rerunning compilation after changes have been made
    • changes can include changing which repos are listed in the profile config file, or updates to the code in the repo
    • what to do to make sure these changes are pulled in before compilation

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

N/A

Additional context

Add any other context or screenshots about the feature request here.

N/A

@greenbreakfast greenbreakfast added the documentation Improvements or additions to documentation label Jan 29, 2025
@remingtontr
Copy link
Contributor

Lazar, I have made the requested changes to the file and uploaded a new version of the file on the Google Drive. Please review and let me know if further changes are needed.

Tomas

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: In Review
Development

No branches or pull requests

2 participants