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

Add howto about migrating a package to package spec v2 #964

Merged

Conversation

jsoriano
Copy link
Member

@jsoriano jsoriano commented Sep 8, 2022

Add documentation about how to solve validation issues found with packages following the package spec v2.

Part of elastic/package-spec#399.
Fixes #963 (additional implemented validations should include their own docs in this document).

@jsoriano jsoriano self-assigned this Sep 8, 2022
@jsoriano jsoriano requested a review from a team September 8, 2022 10:56
Copy link
Contributor

@mrodm mrodm left a comment

Choose a reason for hiding this comment

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

LGTM
And those examples with possible errors will help for sure developers to upgrade the packages from v1 to v2 👍

@elasticmachine
Copy link
Collaborator

elasticmachine commented Sep 8, 2022

💔 Build Failed

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-09-08T11:40:36.676+0000

  • Duration: 31 min 16 sec

Test stats 🧪

Test Results
Failed 0
Passed 808
Skipped 0
Total 808

Steps errors 1

Expand to view the steps failures

authenticate
  • Took 0 min 1 sec . View more details here
  • Description: gcloud auth activate-service-account --key-file ${FILE_CREDENTIAL}

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@mtojek
Copy link
Contributor

mtojek commented Sep 8, 2022

Version of the Package Spec used by a package is defined by the `format_version`
setting in the `manifest.yml` file.

## Upgrading from Package Spec v1 to v2
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: I would add a prefix "Troubleshooting" as this is rather information about how to fix an issue.

@elasticmachine
Copy link
Collaborator

elasticmachine commented Sep 8, 2022

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (33/33) 💚
Files 67.213% (82/122) 👍
Classes 62.941% (107/170) 👍
Methods 49.713% (346/696) 👎 -0.216
Lines 33.355% (3151/9447) 👍
Conditionals 100.0% (0/0) 💚

@jsoriano
Copy link
Member Author

jsoriano commented Sep 8, 2022

Failure is unrelated, merging.

@jsoriano jsoriano merged commit 315c456 into elastic:main Sep 8, 2022
@jsoriano jsoriano deleted the document-migration-to-package-spec-v2 branch September 8, 2022 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document guidelines for upgrading to package spec 2.0.0
4 participants