Skip to content

Commit

Permalink
Merge branch 'main' into patch-3
Browse files Browse the repository at this point in the history
  • Loading branch information
javierlozallu authored Apr 3, 2024
2 parents 2d1e2f4 + 72d6239 commit 5a01556
Show file tree
Hide file tree
Showing 19 changed files with 1,090 additions and 196 deletions.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: 🗣 Subproject discussions
url: https://github.com/camaraproject/EdgeCloud/discussions
about: Please ask and answer questions here.
- name: 📖 CAMARA API Design Guidelines
url: https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md
about: Please refer to the design guidelines.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_correction_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: ❗ Correction 👣
about: Suggest the correction of an issue in API specification or a misalignment with API design guidelines
title: ''
labels: 'correction'
assignees: ''

---

**Problem description**
<!-- A clear and concise description of what the problem is. -->

**Expected behavior**
<!-- A clear and concise description of what should be changed. -->


**Alternative solution**
<!-- A clear and concise description of any alternative solutions if any. -->

**Additional context**
<!-- Add any other context of the considered correction. -->
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_documentation_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: ❕ Documentation 📝
about: Indicate an issue with API documentation or supplementary documents
title: ''
labels: 'documentation'
assignees: ''

---

**Problem description**
<!-- A clear and concise description of what the problem is. -->

**Expected action**
<!-- A clear and concise description of what should be done. -->


**Additional context**
<!-- Add any other context of the documentation issue e.g. reference documents. -->
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_enhancement_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: 💡 Enhancement 🌟
about: Suggest an idea for a new API feature or pose a question on directions for API evolution
title: ''
labels: 'enhancement'
assignees: ''

---

**Problem description**
<!-- A clear and concise description of what the problem is. -->

**Possible evolution**
<!-- A clear and concise description of what can be modified. -->

**Alternative solution**
<!-- A clear and concise description of any alternative solutions or features if any -->

**Additional context**
<!-- Add any other context of the considered enhancement. -->
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_pm_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: ☁ Subproject management 🎂
about: Indicate an issue with subproject repository or release management
title: ''
labels: 'subproject management'
assignees: ''

---

**Problem description**
<!-- A clear and concise description of what the problem is. -->

**Expected action**
<!-- A clear and concise description of what should be done. -->


**Additional context**
<!-- Add any other context of the management issue e.g. reference documents. -->
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_tests_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: ⁉ Tests 🔎
about: Indicate an issue with API tests
title: ''
labels: 'tests'
assignees: ''

---

**Problem description**
<!-- A clear and concise description of what the problem is. -->

**Expected action**
<!-- A clear and concise description of what should be done. -->


**Additional context**
<!-- Add any other context of the documentation issue e.g. logs, reference documents. -->
45 changes: 45 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
#### What type of PR is this?

Add one of the following kinds:
* bug
* correction
* enhancement/feature
* cleanup
* documentation
* subproject management
* tests


#### What this PR does / why we need it:




#### Which issue(s) this PR fixes:

<!-- Automatically closes linked issue when PR is merged.
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`. -->

Fixes #

#### Special notes for reviewers:



#### Changelog input

```
release-note
```

#### Additional documentation

This section can be blank.



```
docs
```
78 changes: 78 additions & 0 deletions .github/workflows/megalinter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
# MegaLinter GitHub Action configuration file
# More info at https://megalinter.io
# CAMARA Project - Github Action for Pull Reqests
# 31.01.2024 - initial version

name: MegaLinter

on: # yamllint disable-line rule:truthy
# Pull Requests to main
pull_request:
branches: [master, main]

env: # Comment env block if you do not want to apply fixes
# Apply linter fixes configuration
APPLY_FIXES: all # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
APPLY_FIXES_EVENT: pull_request # Decide which event triggers application of fixes in a commit or a PR (pull_request, push, all)
APPLY_FIXES_MODE: commit # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request)

concurrency:
group: ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress: true

jobs:
build:
name: MegaLinter
runs-on: ubuntu-latest
permissions:
# Give the default GITHUB_TOKEN write permission to commit and push, comment issues & post new PR
# Remove the ones you do not need
contents: write
issues: write
pull-requests: write
steps:
# Git Checkout
- name: Checkout Code
uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
fetch-depth: 0 # If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to improve performances
- name: Install Spectral
run: npm install -g @stoplight/spectral
- name: Install Spectral functions
run: npm install -g @stoplight/spectral-functions
# - name: Run spectral:oas Spectral Linting
# run: spectral lint code/API_definitions/*.yaml --verbose --ruleset .spectral.yml
# Replace openapi.yaml file with your API specification file

# MegaLinter
- name: MegaLinter
id: ml
# You can override MegaLinter flavor used to have faster performances
# More info at https://megalinter.io/flavors/
uses: oxsecurity/megalinter/flavors/[email protected]
env:
# All available variables are described in documentation
# https://megalinter.io/configuration/
PRINT_ALPACA: false
# VALIDATE_ALL_CODEBASE: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} # Validates all source when push on main, else just the git diff with main. Override with true if you always want to lint all sources
VALIDATE_ALL_CODEBASE: true
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
DISABLE: COPYPASTE,MARKDOWN
DISABLE_LINTERS: SPELL_CSPELL,SPELL_LYCHEE,YAML_PRETTIER,REPOSITORY_GRYPE, REPOSITORY_SEMGREP,REPOSITORY_DEVSKIM,REPOSITORY_KICS,REPOSITORY_TRIVY,REPOSITORY_TRIVY_SBOM,REPOSITORY_TRUFFLEHOG,REPOSITORY_CHECKOV,REPOSITORY_GITLEAKS,YAML_V8R,JAVA_PMD,JAVA_CHECKSTYLE
YAML_YAMLLINT_CONFIG_FILE: ".yamllint.yaml"
OPENAPI_SPECTRAL_CONFIG_FILE: ".spectral.yml"
YAML_YAMLLINT_FILTER_REGEX_INCLUDE: "(code/)"
OPENAPI_SPECTRAL_FILTER_REGEX_INCLUDE: "(code/)"

# Upload MegaLinter artifacts
- name: Archive production artifacts
if: ${{ success() }} || ${{ failure() }}
uses: actions/upload-artifact@v4
with:
name: MegaLinter reports
path: |
megalinter-reports
mega-linter.log
36 changes: 36 additions & 0 deletions .github/workflows/spectral_oas_lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
# CAMARA Project - workflow configuration to manually run CAMARA OAS rules
# see https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow
# 31.01.2024 - initial version

name: Spectral manual run

on: workflow_dispatch

concurrency:
group: ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress: true

jobs:
build:
name: Spectral linting
runs-on: ubuntu-latest
permissions:
# Give the default GITHUB_TOKEN write permission to commit and push, comment issues & post new PR
# Remove the ones you do not need
contents: write
issues: write
pull-requests: write
steps:
# Git Checkout
- name: Checkout Code
uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
fetch-depth: 0 # If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to improve performances
- name: Install Spectral
run: npm install -g @stoplight/spectral
- name: Install Spectral functions
run: npm install -g @stoplight/spectral-functions
- name: Run Spectral linting
run: spectral lint code/API_definitions/*.yaml --verbose --ruleset .spectral.yml
Loading

0 comments on commit 5a01556

Please sign in to comment.