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

Manfiest Generation / Validation / PR User Experience Problems #669

Closed
chrpai opened this issue May 21, 2020 · 4 comments
Closed

Manfiest Generation / Validation / PR User Experience Problems #669

chrpai opened this issue May 21, 2020 · 4 comments
Labels
Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. No-Recent-Activity No activity has occurred on this work item for seven days.
Milestone

Comments

@chrpai
Copy link
Contributor

chrpai commented May 21, 2020

Description of the new feature/enhancement

Complete/Sync/Test business rules in CreateYAML.PS1, WinGet, BOT and Documentation

A user would be able to succesfully submit a PR on the first attempt. I've seen at least several inconsistencies in my first (failed) attempt.

The CreateYAML.PS1 accepted an arch (x86, x64) that winget validate failed. The documentation says enumeration of supported architectures but does not say what these values are and how many you can use.

The BOT failed my ID saying that it must be Publisher.Package. The CreateYAML.ps1 and winget validate and documentation doesn't enforce this. In fact the web documentations good/better examples and winget search show that this isn't a rule at all.

The BOT suggests that I should use VS Code when the GitHub repos suggests using CreateYAML.PS1.

These inconsistencies really drag down the UX of the people that you are trying to get to contribute to this repos.

Proposed technical implementation details (optional)

I'd consistency and great documentation so that any PR failures are clearly my fault and not secret handshake problems.

@chrpai chrpai added the Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. label May 21, 2020
@chrpai
Copy link
Contributor Author

chrpai commented May 28, 2020

Glad to know I'm not alone!
image

@denelon
Copy link
Contributor

denelon commented Aug 11, 2020

@chrpai we've made quite a few improvements over the last few months. Many of the issues have been related to a combination of business rules being implemented in multiple places. We've consolidated much of this by leveraging the client code in the pipelines validating manifests.

In addition, several of the steps in the validation process are inherently closed systems with limited output. Many changes have already been implemented to provide better messaging directly to users when they submit a PR and there are issues with invalid manifest files, SHA256 codes, SmartScreen validation, and other static analysis.

We have also been working with some of these other systems/internal teams to expose more granular output to us so we can in turn expose it to users directly in PR comments (and labels).

We currently don't support multiple architectures in one manifest, but that's on the backlog.
microsoft/winget-cli#132

@denelon
Copy link
Contributor

denelon commented Jan 6, 2021

@chrpai we are building a wizard to help build and submit manifests. Our intent is to make it easier to build and submit a valid manifest.

@ghost ghost added the No-Recent-Activity No activity has occurred on this work item for seven days. label Jan 13, 2021
@ghost
Copy link

ghost commented Jan 13, 2021

This issue has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 7 days. It will be closed if no further activity occurs within 7 days of this comment.

@ghost ghost closed this as completed Jan 20, 2021
@denelon denelon added this to the 1.7 Packages milestone Nov 1, 2023
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. No-Recent-Activity No activity has occurred on this work item for seven days.
Projects
None yet
Development

No branches or pull requests

2 participants