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

Update CI #2

Merged
merged 2 commits into from
Oct 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .ecrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"Exclude": [
".git"
]
}
6 changes: 6 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# EditorConfig is awesome: https://EditorConfig.org

[*]
# Ensure consistent file encoding in UNIX style
charset = utf-8
end_of_line = lf
42 changes: 42 additions & 0 deletions .github/workflows/check-generic.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Generic checks to ease collaboration:
# - consistent file encoding in UNIX style
# - whitespaces in all purposes files like markdown, yaml, etc
name: Check Generic

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
editorconfig-checker:
name: Run editorconfig-checker
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install editorconfig-checker
run: pipx install "editorconfig-checker"
- name: Run editorconfig-checker
run: ec .

markdownlint:
name: Run markdownlint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run markdownlint-cli2
uses: DavidAnson/markdownlint-cli2-action@v13

yamllint:
name: Run yamllint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run yamllint
run: yamllint .
18 changes: 0 additions & 18 deletions .github/workflows/markdown-lint.yaml

This file was deleted.

38 changes: 38 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# MkDocs output
site/

# KiCad
# For PCBs designed using KiCad: https://www.kicad.org/
# Format documentation: https://kicad.org/help/file-formats/

# Temporary files
*.000
*.bak
*.bck
*.kicad_pcb-bak
*.kicad_sch-bak
*-backups
*.kicad_prl
*.sch-bak
*~
_autosave-*
*.tmp
*-save.pro
*-save.kicad_pcb
fp-info-cache

# Netlist files (exported from Eeschema)
*.net

# Autorouter files (exported from Pcbnew)
*.dsn
*.ses

# Exported BOM files
# *.xml
# *.csv

# custom
.DS_Store
.pio/
.vscode/
4 changes: 0 additions & 4 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,3 @@ config:
# Define glob expressions to use (only valid at root)
globs:
- "**/*.md"

# Define glob expressions to ignore
# ignores:
# - "ignore*.md"
8 changes: 8 additions & 0 deletions .yamllint
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
extends: default

rules:
document-start: disable
indentation:
spaces: 2
truthy:
check-keys: false
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
>
<img
alt="GitHub Workflow Status"
src="https://img.shields.io/github/actions/workflow/status/EnAccess/Cicada-WiFi-HW/markdown-lint.yaml"
src="https://img.shields.io/github/actions/workflow/status/EnAccess/Cicada-WiFi-HW/check-generic.yaml"
>
<a href="https://github.com/EnAccess/Cicada-WiFi-HW/blob/main/LICENSE" target="_blank">
<img
Expand All @@ -34,7 +34,7 @@
Cicada WiFi HW - IoT Communications Module for Energy Access.
An easy way to get production ready, bi-directional communications for your IoT embedded device.

This repository contains the hardware design for supported Cicada wifi. This HW is designed to operate with host running cicada-FW. <https://github.com/EnAccess/Cicada-FW>
This repository contains the hardware design for supported Cicada wifi. This HW is designed to operate with host running cicada-FW. <https://github.com/EnAccess/Cicada-FW>

## Manufacturing files

Expand Down