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

build(snap): source metadata from central repo #3959

Merged
merged 3 commits into from
Apr 12, 2022

Conversation

MonicaisHer
Copy link
Contributor

The metadata kept in snapcraft.yaml is obsolete because it is being overridden on the store. This change will allow sourcing the central copy of metadata.

See canonical/edgex-snap-metadata#2

Signed-off-by: Mengyi Wang [email protected]

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-go/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

  • I am not introducing a breaking change (if you are, flag in conventional commit message with BREAKING CHANGE: describing the break)
  • I am not introducing a new dependency (add notes below if you are)
  • I have added unit tests for the new feature or bug fix (if not, why?)
  • I have fully tested (add details below) this the new feature or bug fix (if not, why?)
  • I have opened a PR for the related docs change (if not, why?)

Testing Instructions

# clean and build:
$ snapcraft clean && snapcraft

# unpack the built snap:
$ unsquashfs name.snap

# verify that icon exists:
$ ls squashfs-root/meta/gui/icon.png 
squashfs-root/meta/gui/icon.png

# verify that version, summary and description are included:
$ cat squashfs-root/meta/snap.yaml
...
version: 2.0.1-dev.71
summary: Open-source framework for IoT edge computing
description: |-
  EdgeX Foundry is a vendor-neutral, highly flexible and scalable open-source framework hosted by The Linux Foundation. It enables developers to build apps that run at the edge, acting as a middleware between the things and the cloud.

  It provides the components to develop microservices responsible for data acquisition, data analytics and cloud connectors, exposing a rich set of APIs to allow full control of the system and configuration. The reference architecture allows scaling out to thousands of devices and sensors.

  This snap is a part of EdgeX Foundry and contains the following reference services:

  **Core Services**
  * Core Data
  * Core Command
  * Core Metadata
  * Registry and Config (Consul)
  * Message Bus (Redis)

  **Supporting Services**
  * Rules Engine (eKuiper)
  * Scheduling
  * Alerts & Notifications

  **Application Services**
  * Configurable Application Service

  **Security Services**
  * API Gateway a.k.a. Reverse Proxy (Kong)
  * Secret Store (Vault)

  **Management Services**
  * Management Service Agent (deprecated)

  **Device Services**
  * Virtual

  Note that not all the above services are enabled and started by default.

  =============

  **Further Reading**
  * Getting started with snaps (v2.1): https://docs.edgexfoundry.org/2.1/getting-started/Ch-GettingStartedSnapUsers
  * Snap usage instructions: https://github.com/edgexfoundry/edgex-go/blob/main/snap/README.md
  * EdgeX documentation: https://docs.edgexfoundry.org
  * Source code: https://github.com/edgexfoundry/edgex-go

  ====================

  **Development Tool Snaps**
  * EdgeX UI: https://snapcraft.io/edgex-ui
  * EdgeX CLI: https://snapcraft.io/edgex-cli

  **Other Supported EdgeX Snaps**
  * App Service Configurable: https://snapcraft.io/edgex-app-service-configurable
  * Device Camera: https://snapcraft.io/edgex-device-camera
  * Device Modbus: https://snapcraft.io/edgex-device-modbus
  * Device MQTT: https://snapcraft.io/edgex-device-mqtt
  * Device REST: https://snapcraft.io/edgex-device-rest
  * Device SNMP: https://snapcraft.io/edgex-device-snmp
  * Device Grove: https://snapcraft.io/edgex-device-grove

  **Additional References**
  * Redis: https://github.com/redis/redis
  * Consul: https://github.com/hashicorp/consul
  * eKuiper: https://github.com/lf-edge/ekuiper
  * Kong: https://github.com/Kong/kong
  * Vault: https://github.com/hashicorp/vault
...

New Dependency Instructions (If applicable)

@codecov-commenter
Copy link

Codecov Report

Merging #3959 (bfd46bb) into main (ecc8587) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #3959   +/-   ##
=======================================
  Coverage   46.80%   46.80%           
=======================================
  Files         112      112           
  Lines        9727     9727           
=======================================
  Hits         4553     4553           
  Misses       4787     4787           
  Partials      387      387           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ecc8587...bfd46bb. Read the comment docs.

@farshidtz farshidtz self-requested a review April 12, 2022 10:15
Copy link
Member

@farshidtz farshidtz left a comment

Choose a reason for hiding this comment

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

Thanks. Tested and the metadata is fetched from the AppStream source.

Please see the inline comment.

snap/snapcraft.yaml Show resolved Hide resolved
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@MonicaisHer MonicaisHer requested a review from farshidtz April 12, 2022 11:28
@farshidtz farshidtz merged commit ad3b9b7 into edgexfoundry:main Apr 12, 2022
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.

3 participants