Skip to content

Commit

Permalink
Add SPDX landscape workflows and settings (#57)
Browse files Browse the repository at this point in the history
Signed-off-by: Sergio Castaño Arteaga <[email protected]>
Signed-off-by: Cintia Sanchez Garcia <[email protected]>
Co-authored-by: Sergio Castaño Arteaga <[email protected]>
Co-authored-by: Cintia Sanchez Garcia <[email protected]>
  • Loading branch information
tegioz and cynthia-sg authored Nov 20, 2023
1 parent dde10e8 commit 47a4ca7
Show file tree
Hide file tree
Showing 4 changed files with 232 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/spdx-build-and-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: SPDX build and deploy

on:
schedule:
- cron: "0 19 * * *"
workflow_dispatch:

jobs:
build-landscape:
uses: cncf/landscape2-sites/.github/workflows/build-and-deploy.yml@main
with:
foundation: spdx
repository: spdx/sbom-landscape
secrets: inherit
18 changes: 18 additions & 0 deletions .github/workflows/spdx-validate-settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: SPDX validate settings

on:
pull_request:
branches:
- main
paths:
- spdx/settings.yml

jobs:
validate-landscape-settings:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: cncf/landscape2-validate-action@v2
with:
target_kind: settings
target_path: spdx/settings.yml
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ This repository contains the settings and deployment workflows of some foundatio
| [![OpenSSF build and deploy](https://github.com/cncf/landscape2-sites/actions/workflows/openssf-build-and-deploy.yml/badge.svg?branch=main)](https://github.com/cncf/landscape2-sites/actions/workflows/openssf-build-and-deploy.yml) | <https://openssf.landscape2.io> |
| [![OSPO build and deploy](https://github.com/cncf/landscape2-sites/actions/workflows/ospo-build-and-deploy.yml/badge.svg?branch=main)](https://github.com/cncf/landscape2-sites/actions/workflows/ospo-build-and-deploy.yml) | <https://ospo.landscape2.io> |
| [![Presto build and deploy](https://github.com/cncf/landscape2-sites/actions/workflows/presto-build-and-deploy.yml/badge.svg?branch=main)](https://github.com/cncf/landscape2-sites/actions/workflows/presto-build-and-deploy.yml) | <https://presto.landscape2.io> |
| [![SPDX build and deploy](https://github.com/cncf/landscape2-sites/actions/workflows/spdx-build-and-deploy.yml/badge.svg?branch=main)](https://github.com/cncf/landscape2-sites/actions/workflows/spdx-build-and-deploy.yml) | <https://spdx.landscape2.io> |
| [![RISCV build and deploy](https://github.com/cncf/landscape2-sites/actions/workflows/riscv-build-and-deploy.yml/badge.svg?branch=main)](https://github.com/cncf/landscape2-sites/actions/workflows/riscv-build-and-deploy.yml) | <https://riscv.landscape2.io> |

## Contributing
Expand Down
199 changes: 199 additions & 0 deletions spdx/settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,199 @@
# Landscape2 settings
#
# This settings file allows customizing some aspects of the landscape.

# Foundation (required)
#
# Name of the foundation. This value is used in some labels, so we recommended
# to keep it as short as possible.
#
# foundation: <FOUNDATION_NAME>
#
foundation: SPDX

# Images (required)
#
# Urls some images used in the landscape UI.
#
# images:
# favicon: <FAVICON_URL>
# footer_logo: <FOOTER_LOGO_URL>
# header_logo: <HEADER_LOGO_URL>
# open_graph: <OPEN_GRAPH_IMAGE_URL>
#
images:
favicon: "https://spdx.dev/wp-content/uploads/sites/31/2023/08/favicon-150x150.png"
footer_logo: "https://spdx.dev/wp-content/uploads/sites/31/2023/08/logo-white.svg"
header_logo: "https://raw.githubusercontent.com/spdx/sbom-landscape/1f5537571ee3acf6a17fe339cab3615073f1bf39/images/left-logo.svg"
open_graph: "https://spdx.dev/wp-content/uploads/sites/31/2023/08/favicon.png"

# Categories (optional)
#
# Categories information is read from the `landscape.yml` data file. The way
# categories are displayed in the web application is computed dynamically based
# on the number of categories and subcategories, as well as the number of items
# on each. Sometimes, however, we may want subcategories to be displayed in a
# specific order within a category (this happens often in the Members category).
# In those cases, it is possible to define that order by overriding a category.
#
# This option can also be used to not display one or more subcategories in the
# landscape. To achieve that, we only need to exclude the subcategory from the
# subcategories list when overriding a category.
#
# categories:
# - name: <CATEGORY_NAME>
# subcategories:
# - <SUBCATEGORY1_NAME>
# - <SUBCATEGORY2_NAME>
#

# Colors (optional)
#
# Colors used across the landscape UI. The colors section is optional but, when
# provided, *all colors must be provided*. Colors must be specified using the
# following format: "rgba(<RED>, <GREEN>, <BLUE>, <ALPHA>)".
#
# colors:
# color1: <COLOR1> # Buttons, groups, links
# color2: <COLOR2> # Some highlighted items like filters button, search icon
# color3: <COLOR3> # Participation stats bars, spinners, modal titles
# color4: <COLOR4> # Categories titles in filters, fieldset in filters modal
# color4: <COLOR5> # Categories and subcategories frames (odd)
# color5: <COLOR6> # Categories and subcategories frames (even)
#
colors:
color1: "rgba(5, 85, 182, 1)"
color2: "rgba(42, 125, 225, 1)"
color3: "rgba(69, 73, 143, 1)"
color4: "rgba(69, 73, 143, 0.7)"
color5: "rgba(5, 85, 182, 0.7)"
color6: "rgba(69, 73, 143, 0.7)"

# Featured items (optional)
#
# This section allows highlighting items that match certain criteria. You can
# define a list of rules and the matching items will be featured in a special
# way in the landscape.
#
# Each rule must define a field for the check as well as the values that will
# trigger a match. At the moment the fields supported are:
#
# - maturity
# - subcategory
#
# When a given item's field matches any of the values provided, it will be
# considered a featured item. For each option, it is possible to also define an
# order (which item would be displayed first) and a label for the item.
#
# featured_items:
# - field: subcategory
# options:
# - value: <SUBCATEGORY1_NAME>
# - value: <SUBCATEGORY2_NAME>
#

# Grid items size (optional)
#
# Defines the preferred size of the landscape items in the grid mode. When the
# landscape contains many items, it is recommended to use the `small` size.
# However, if there aren't many items, choosing `medium` or `large` may make
# the landscape look nicer. Users will still be able to adjust the items size
# from the UI using the zoom controls.
#
# grid_items_size: <small|medium|large>
#
grid_items_size: large

# Groups (optional)
#
# In some cases, specially when a landscape contains lots of items, it may be
# interesting to organize them in groups. Each group will be displayed on a
# different tab in the landscape web application. Each entry must contain the
# name of the group (it will be displayed as is) and a list with the categories
# (as defined in the landscape.yml data file) that will be part of this group.
#
# groups:
# - name: <GROUP_NAME>
# categories:
# - <CATEGORY1_NAME>
# - <CATEGORY2_NAME>
#

# Name of the members category (optional)
#
# Landscapes usually have a special category dedicated to the members of the
# corresponding foundation. It is possible to use any name for that category,
# but it is important that we define it here as there are some special
# operations that depend on it.
#
# members_category: <CATEGORY_NAME>
#

# QR code configuration (optional)
#
# Defines the configuration of the QR code that will be displayed on the UI as
# well as on the downloadable landscape in PDF and PNG formats.
#
# qr_code:
# url: <URL>
#
qr_code:
url: https://spdx.landscape2.io

# Screenshot width (optional)
#
# Width of the landscape screenshots automatically generated (in pixels).
# Screenshots won't be taken if this value is not provided.
#
# screenshot_width: <WIDTH_IN_PIXELS>
#
screenshot_width: 1500

# Social networks urls (optional)
#
# List of social networks urls that will be used to create some links in the
# landscape web application.
#
# social_networks:
# facebook: <FACEBOOK_URL>
# flickr: <FLICKR_URL>
# github: <GITHUB_URL>
# instagram: <INSTAGRAM_URL>
# linkedin: <LINKEDIN_URL>
# slack: <SLACK_URL>
# twitch: <TWITCH_URL>
# twitter: <TWITTER_URL>
# wechat: <WECHAT_URL>
# youtube: <YOUTUBE_URL>
#
social_networks:
github: "https://github.com/spdx"
twitter: "https://twitter.com/SPDXTeam"

# TAGs (optional)
#
# Projects items can specify which TAG owns them in the `landscape.yml` file
# (by using the `tag` field in the `extra` item's section). However, sometimes
# this information is not available at the item level. This configuration
# section provides a mechanism to automatically asign a TAG to projects items
# based on the categories and subcategories they belong to.
#
# For example, we can define that all projects in the category <CATEGORY1> are
# owned by <TAG1>. When the items are processed, the corresponding TAG will be
# set in the items that match the rule defined. The TAG defined at the item
# level always takes precedence, so when it's present it won't be replaced.
#
# NOTE: TAGs names should only use lowercase case letters and hyphens (no
# spaces or other characters), and should not be prefixed with "tag". The
# subcategories field is optional and, when omitted, all of them will be
# included.
#
# tags:
# <TAG1>:
# - category: <CATEGORY1>
# subcategories:
# - <SUBCATEGORY1>
# - <SUBCATEGORY2>
# <TAG2>:
# - category: <CATEGORY2>
#

0 comments on commit 47a4ca7

Please sign in to comment.