Skip to content

Commit

Permalink
Merge pull request #7 from gfurtadoalmeida/new-pipeline
Browse files Browse the repository at this point in the history
New pipeline
  • Loading branch information
gfurtadoalmeida authored Dec 21, 2023
2 parents 05705da + 5fcd1c5 commit 3355fa3
Show file tree
Hide file tree
Showing 9 changed files with 388 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@gfurtadoalmeida
104 changes: 104 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
name: ❗ Bug Report
description: Create a report to help us improve.
title: "[Bug]: "
labels: ['bug']
body:
- type: markdown
attributes:
value: |
We welcome bug reports! This template will help us gather the information we need to start the triage process.
- type: textarea
id: background
attributes:
label: Description
description: Please share a clear and concise description of the problem.
placeholder: Description
validations:
required: true
- type: textarea
id: repro-steps
attributes:
label: Reproduction Steps
description: |
Please include minimal steps to reproduce the problem if possible. E.g.: the smallest possible code snippet; or a small project, with steps to run it.
We will close this issue if:
- We are not able to reproduce the behavior you're reporting.
- The issue is a duplicate of an existing issue.
- The behavior you're reporting is by design.
placeholder: Minimal Reproduction
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: |
Provide a description of the expected behavior.
placeholder: Expected behavior
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: |
Provide a description of the actual behavior. If applicable please include any error messages, exception stacktraces or memory dumps.
placeholder: Actual behavior
validations:
required: true
- type: dropdown
id: display-serie
attributes:
label: Display serie.
description: Which Nextion display serie does your application uses?
multiple: false
options:
- Basic
- Discovery
- Enhanced
- Intelligent
validations:
required: true
- type: input
id: display-model
attributes:
label: Display model.
description: Which Nextion display model does your application uses?
placeholder: ex. NX4832T035
validations:
required: true
- type: input
id: idf-version
attributes:
label: IDF version.
description: On which IDF version does this issue occur on?
placeholder: ex. v3.2-dev-1148-g96cd3b75c
validations:
required: true
- type: input
id: chip-revision
attributes:
label: Espressif SoC revision.
description: On which Espressif SoC revision does your application run on?
placeholder: ex. ESP32-C3 (QFN32) (revision v0.3)
validations:
required: true
- type: textarea
id: debug-logs
attributes:
label: Debug Logs.
description: Debug log goes here, should contain the backtrace, as well as the reset source if it is a crash.
placeholder: Your log goes here.
render: plain text
validations:
required: false
- type: textarea
id: other-info
attributes:
label: Other information
description: |
If you have an idea where the problem might lie, let us know that here. Please include any pointers to code, relevant changes, or related issues you know of.
placeholder: Other information
validations:
required: false
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: 💡 Feature request
description: Propose a feature or improvement
title: '[Feature request]: '
labels: ['feature']
body:
- type: markdown
attributes:
value: |
We welcome feature requests! This template will help us gather the information we need to start the review process.
- type: textarea
id: background
attributes:
label: Background and motivation
description: Please describe the purpose and value of the new feature.
placeholder: Purpose
validations:
required: true
- type: textarea
id: description
attributes:
label: Describe the solution expected
description: |
Please provide a clear and concise description of what you want to happen.
placeholder: Description
validations:
required: true
- type: textarea
id: additional-info
attributes:
label: Additional info
description: |
Add any other information about the feature request here.
placeholder: Additional info
validations:
required: false
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull-request-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Pull Request

## Details

Please explain the changes you made here.

## Checklist

- [ ] PR started by branching from the head of the default branch
- [ ] PR targeted to merge into the default branch
- [ ] Created tests which fail without the change
- [ ] All tests passing
- [ ] Successfully ran a local build

## Where has this been tested?

- Display serie:
- Display model:
- IDF version:
- Espressif SoC revision:
14 changes: 11 additions & 3 deletions .github/workflows/build.yml → .github/workflows/development.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
name: build
name: development

on:
push:
branches: [ "master" ]
branches: ["master"]
paths:
- 'components/**'
- 'main/**'
- 'test/**'
pull_request:
branches: [ "master" ]
types:
- opened
- edited
- synchronize
- reopened
paths:
- 'components/**'
- 'main/**'
- 'test/**'
workflow_dispatch:

env:
Expand Down
70 changes: 70 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: release

on:
push:
tags:
- 'v[0-9]+.[0-9]+.[0-9]+*'

jobs:
build:
runs-on: ubuntu-latest

env:
esp_docker_image: gfurtadoalmeida/esp32-docker-sonar:v5.1

steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Docker Login
uses: docker/[email protected]
with:
username: ${{secrets.DOCKER_USERNAME}}
password: ${{secrets.DOCKER_TOKEN}}

- name: Pull ESP-IDF Image
shell: pwsh
run: docker pull ${{env.esp_docker_image}}

- name: Build
shell: pwsh
run: docker run --rm --env LC_ALL='C.UTF-8' -v ${{github.workspace}}:/project -w /project ${{env.esp_docker_image}} idf.py build

- name: Build Test
shell: pwsh
run: docker run --rm --env LC_ALL='C.UTF-8' -v ${{github.workspace}}:/project -w /project ${{env.esp_docker_image}} idf.py -C ./test build

release:
runs-on: windows-2022
needs: [build]
permissions:
contents: write

env:
ZIP_NAME: esp32-driver-nextion.${{github.ref_name}}.zip

steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Create Zip
shell: pwsh
run: |
$compress = @{
Path = "components/esp32_driver_nextion/*"
CompressionLevel = "Optimal"
DestinationPath = $Env:ZIP_NAME
}
Compress-Archive @compress
- name: Publish
uses: ncipollo/release-action@v1
with:
allowUpdates: true
artifacts: "${{env.ZIP_NAME}}"
makeLatest: true
name: ESP32 Driver Nextion ${{github.ref_name}}
removeArtifacts: false
replacesArtifacts: true
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[@gfurtadoalmeida](https://twitter.com/gfurtadoalmeida).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
Loading

0 comments on commit 3355fa3

Please sign in to comment.