Skip to content

Commit

Permalink
feat(.github): Add Github Actions
Browse files Browse the repository at this point in the history
Signed-off-by: ESCristiano <[email protected]>
  • Loading branch information
ESCristiano committed Sep 29, 2023
1 parent 2c78d0a commit 8707443
Show file tree
Hide file tree
Showing 9 changed files with 251 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Maintainers
* @ESCristiano @miguelafsilva5
4 changes: 4 additions & 0 deletions .github/CONTRIBUTORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# File with a list of people who contributed to this repository
# List sorted by first names.

Cristiano Rodrigues <[email protected]>
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] add short description of bug"
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior :
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEAT-REQ] add short description of the feat-request"
labels: feature-request
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
55 changes: 55 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
## PR Description

Before saving the PR, please delete this description and add only your summary/description of the PR.
Please include a summary of the change that tries to answer the following general questions:
- What does this change introduces? Why is it required?
- Which main blocks are affected?

If your changes are included in the following categories, please try also to answer to these specific questions if they enhance your summary:
- The PR changes introduces a new feature...
- What new feature is being introduced?
- Is the feature described in any of the requirements?
- The PR changes solves a bug...
- What bug does it solve? What was the previous behavior/warning/error?
- Is the bug described in any issue ticket number?
- The PR changes refactors a code/doc block...
- Why the code/doc block needed to be refactored?
- Is the improvement described in any issue ticket number?
- The PR changes the build system...
- What building block of the build system was changed?
- Has any external dependency introduced?
- The PR changes improves the overall performance of the system...
- Did you quantify the improvement on performance? Please share the numbers.
- The PR changes or adds new tests...
- What new tests were introduced or corrected?

### Type of change

Before saving the PR, please delete this description and the below options that are not relevant.
If you are not sure which type of change are you introducing, please read [Contributing](https://github.com/bao-project/bao-docs/blob/main/source/development/contributing.rst) documentation.

- **feat**: introduces a new functionality
- Logical unit: <name>
- **fix**: bug fix
- Logical unit: <name>
- Fixes a specific issue: <#ticket-number>
- **ref**: refactoring of a code/doc block
- Logical unit: <name>
- **build**: changes that affect the build system or external dependencies
- Logical unit: <name>
- **doc**: documentation only changes
- Files affected: <name>
- **perf**: a code change that improves performance
- Logical unit: <name>
- **test**: adding missing tests or correcting existing ones
- Test unit/suite: <name>
- **opt**: modifications pertaining only to optimizations
- Logical unit: <name>
- **style**: changes that do not affect the meaning of the code (formatting, typos, naming, etc.)
- **update**: changes that brings a feature, setup, or configuration up to date by adding new or updated information
- Logical unit: <name>

## Checklist:

- [ ] The changes generate no new warnings when building the project. If so, I have justified above.
- [ ] I have run the CI checkers before submitting the PR to avoid unnecessary runs of the workflow.
27 changes: 27 additions & 0 deletions .github/templates/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] add short description of bug"
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior :
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/templates/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEAT-REQ] add short description of the feat-request"
labels: feature-request
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
61 changes: 61 additions & 0 deletions .github/templates/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
## PR Description

Before saving the PR, please delete this description and add only your summary/description of the PR.
Please include a summary of the change that tries to answer the following general questions:
- What does this change introduces? Why is it required?
- Which main blocks are affected?

If your changes are included in the following categories, please try also to answer to these specific questions if they enhance your summary:
- The PR changes introduces a new feature...
- What new feature is being introduced?
- Is the feature described in any of the requirements?
- The PR changes solves a bug...
- What bug does it solve? What was the previous behavior/warning/error?
- Is the bug described in any issue ticket number?
- The PR changes refactors a code/doc block...
- Why the code/doc block needed to be refactored?
- Is the improvement described in any issue ticket number?
- The PR changes the build system...
- What building block of the build system was changed?
- Has any external dependency introduced?
- The PR changes improves the overall performance of the system...
- Did you quantify the improvement on performance? Please share the numbers.
- The PR changes or adds new tests...
- What new tests were introduced or corrected?

### Type of change

Before saving the PR, please delete this description and the below options that are not relevant.
If you are not sure which type of change are you introducing, please read [Contributing](https://github.com/bao-project/bao-docs/blob/main/source/development/contributing.rst) documentation.

- **feat**: introduces a new functionality
- Logical unit: <name>
- **fix**: bug fix
- Logical unit: <name>
- Fixes a specific issue: <#ticket-number>
- **ref**: refactoring of a code/doc block
- Logical unit: <name>
- **build**: changes that affect the build system or external dependencies
- Logical unit: <name>
- **doc**: documentation only changes
- Files affected: <name>
- **perf**: a code change that improves performance
- Logical unit: <name>
- **test**: adding missing tests or correcting existing ones
- Test unit/suite: <name>
- **opt**: modifications pertaining only to optimizations
- Logical unit: <name>
- **ci**: changes to the CI configuration files and scripts
- CI checker unit: <name>
- **style**: changes that do not affect the meaning of the code (formatting, typos, naming, etc.)
- **update**: changes that brings a feature, setup, or configuration up to date by adding new or updated information
- Logical unit: <name>

## Checklist:

- [ ] The changes follows the documentation guidelines described in [here](https://github.com/bao-project/bao-docs/blob/main/source/development/doc_guidelines.rst).
- [ ] The changes follows the code documentation guidelines described in [here](https://github.com/bao-project/bao-docs/blob/main/source/development/code_documentation.rst).
- [ ] The changes follows the coding style guidelines described in [here](https://github.com/bao-project/bao-docs/blob/main/source/development/coding_style.rst).
- [ ] The changes follows the MISRA guidelines described in [here](https://github.com/bao-project/bao-docs/blob/main/source/development/misra.rst).
- [ ] The changes generate no new warnings when building the project. If so, I have justified above.
- [ ] I have run the CI checkers before submitting the PR to avoid unnecessary runs of the workflow.
35 changes: 35 additions & 0 deletions .github/workflows/base.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Bao nix workflow

on:
push:
branches: [ main ]
pull_request:
workflow_dispatch:

jobs:

gitlint:
runs-on: ubuntu-latest
container: baoproject/bao:latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- run: git config --global --add safe.directory $(realpath .)
- if: ${{ github.event_name == 'pull_request' }}
run: make gitlint GITLINT_BASE=${{ github.event.pull_request.base.sha }}
- if: ${{ github.event_name == 'push' }}
run: make gitlint GITLINT_BASE=${{ github.event.before }}
- if: ${{ github.event_name == 'workflow_dispatch' }}
run: make gitlint GITLINT_BASE=HEAD

license:
runs-on: ubuntu-latest
container: baoproject/bao:latest
steps:
- uses: actions/checkout@v2
with:
submodules: recursive
fetch-depth: 0
- run: >
make license-check

0 comments on commit 8707443

Please sign in to comment.