Skip to content

Commit bea4faf

Browse files
committed
chore: add initial repo configurations
Signed-off-by: behnazh-w <[email protected]>
1 parent a51bc48 commit bea4faf

15 files changed

+566
-38
lines changed
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior.
4+
title: "[Bug] - [Describe Issue]"
5+
labels: bug, triage
6+
assignees: ''
7+
---
8+
9+
### Description
10+
Please provide a clear and concise description of the issue you're experiencing. Be as detailed as possible about the problem.
11+
12+
### Steps to Reproduce
13+
Please list the steps required to reproduce the issue:
14+
15+
1. **Step 1**: [Describe the first step]
16+
2. **Step 2**: [Describe the second step]
17+
3. **Step 3**: [Describe the third step]
18+
4. [Continue adding steps if necessary]
19+
20+
### Expected Behavior
21+
What were you expecting to happen?
22+
23+
### Actual Behavior
24+
What actually happened? Please include any error messages, logs, or unexpected behavior you observed.
25+
26+
### Debug Information
27+
TODO: Adjust this section.
28+
29+
Please run the command again with the `--verbose` to provide debug information. This will help us diagnose the issue more effectively. You can add this option to the command like this:
30+
31+
TODO
32+
```shell
33+
```
34+
35+
Attach the debug output here if possible.
36+
37+
### Environment Information
38+
To assist with troubleshooting, please provide the following information about your environment:
39+
40+
Operating System: (e.g., Ubuntu 20.04, macOS 11.2)
41+
42+
CPU architecture information (e.g., x86-64 (AMD64))
43+
44+
JDK version
45+
46+
### Screenshots or Logs
47+
If applicable, please provide screenshots or logs that illustrate the bug.
48+
49+
### Additional Information
50+
Any other information that might be useful to identify or fix the bug. For example:
51+
52+
Any steps that worked around the issue
53+
54+
Specific configurations or files that may be relevant

.github/ISSUE_TEMPLATE/config.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Copyright (c) 2025 - 2025, Oracle and/or its affiliates. All rights reserved.
2+
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
3+
4+
blank_issues_enabled: false
5+
contact_links:
6+
- name: GitHub Discussions
7+
url: https://github.com/oracle/macaron-utilities/discussions
8+
about: Please ask and answer questions here.
9+
- name: Security Reports
10+
url: https://github.com/oracle/macaron-utilities/blob/main/SECURITY.md
11+
about: Please report security vulnerabilities following the instructions.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement.
4+
title: "[Feature Request] - [Describe Feature]"
5+
labels: enhancement, feature
6+
assignees: ''
7+
8+
---
9+
10+
### Description
11+
Please provide a clear and concise description of the feature or enhancement you'd like to see in this project. Explain why it would be useful and how it could improve the tool.
12+
13+
### Proposed Feature
14+
What functionality or feature would you like to add to this project? Please describe it in detail.
15+
16+
### Use Case

.github/codeql/codeql-config.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Copyright (c) 2025 - 2025, Oracle and/or its affiliates. All rights reserved.
2+
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
3+
4+
name: CodeQL configuration
5+
# TODO: Complete the following section.
6+
# paths:
7+
# - <path-to-source>

.github/dependabot.yaml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Copyright (c) 2025 - 2025, Oracle and/or its affiliates. All rights reserved.
2+
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
3+
4+
# This configuration file enables Dependabot version updates.
5+
# https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates
6+
# https://github.com/dependabot/feedback/issues/551
7+
8+
version: 2
9+
updates:
10+
- package-ecosystem: maven
11+
directory: / # Location of pom.xml
12+
schedule:
13+
interval: weekly
14+
commit-message:
15+
prefix: chore
16+
prefix-development: chore
17+
include: scope
18+
open-pull-requests-limit: 13
19+
target-branch: main
20+
21+
- package-ecosystem: gradle
22+
directory: / # Location of build.gradle or build.gradle.kts
23+
schedule:
24+
interval: weekly
25+
commit-message:
26+
prefix: chore
27+
prefix-development: chore
28+
include: scope
29+
open-pull-requests-limit: 13
30+
target-branch: main
31+
32+
- package-ecosystem: github-actions
33+
directory: /
34+
schedule:
35+
interval: weekly
36+
commit-message:
37+
prefix: chore
38+
prefix-development: chore
39+
include: scope
40+
open-pull-requests-limit: 13
41+
target-branch: main
42+
43+
# Naming for requirements.txt variants has to include requirements.txt at the end.
44+
# See https://stackoverflow.com/questions/75899186/how-to-configure-dependabot-to-check-multiple-files
45+
- package-ecosystem: pip
46+
directory: /
47+
schedule:
48+
interval: weekly
49+
commit-message:
50+
prefix: chore
51+
prefix-development: chore
52+
include: scope
53+
open-pull-requests-limit: 13
54+
target-branch: main
55+
ignore:
56+
- dependency-name: '*'
57+
update-types:
58+
- version-update:semver-patch

.github/pull_request_template.md

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,32 @@
1-
# Description
2-
3-
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4-
5-
Fixes # (issue)
1+
## Summary
2+
<!-- Briefly summarize the purpose and scope of this PR. -->
63

74
## Type of change
8-
9-
Please delete options that are not relevant.
5+
<!-- Go over following points. check them with an `x` if they do apply. Please delete options that are not relevant. -->
106

117
- [ ] Bug fix (non-breaking change which fixes an issue)
128
- [ ] New feature (non-breaking change which adds functionality)
139
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
1410
- [ ] This change requires a documentation update
1511

16-
# How Has This Been Tested?
12+
## Description of changes
13+
<!-- Provide a detailed explanation of the changes made in this PR, why they were needed, and how they address the issue(s). -->
1714

18-
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
15+
## Related issues
16+
<!-- List any related issue(s) this PR addresses, e.g., `Closes #123`, `Fixes #456`. -->
17+
18+
# How Has This Been Tested?
19+
<!-- Please describe the tests that you ran to verify your changes. -->
1920

2021
- [ ] Test A
2122
- [ ] Test B
2223

23-
**Test Configuration**:
24-
* Firmware version:
25-
* Hardware:
26-
* Toolchain:
27-
* SDK:
28-
29-
# Checklist:
30-
31-
- [ ] My code follows the style guidelines of this project
32-
- [ ] I have performed a self-review of my own code
33-
- [ ] I have commented my code, particularly in hard-to-understand areas
34-
- [ ] I have made corresponding changes to the documentation
35-
- [ ] My changes generate no new warnings
36-
- [ ] I have added tests that prove my fix is effective or that my feature works
37-
- [ ] New and existing unit tests pass locally with my changes
38-
- [ ] Any dependent changes have been merged and published in downstream modules
24+
## Checklist
25+
<!-- Go over following points. check them with an `x` if they do apply, (they turn into clickable checkboxes once the PR is submitted, so no need to do everything at once) -->
26+
27+
- [ ] I have reviewed the [contribution guide](../CONTRIBUTING.md).
28+
- [ ] My PR title and commits follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) convention.
29+
- [ ] My commits include the "Signed-off-by" line.
30+
- [ ] I have signed my commits following the instructions provided by [GitHub](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). Note that we run [GitHub's commit verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) tool to check the commit signatures. A green `verified` label should appear next to **all** of your commits on GitHub.
31+
- [ ] I have updated the relevant documentation, if applicable.
32+
- [ ] I have tested my changes and verified they work as expected.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Copyright (c) 2025 - 2025, Oracle and/or its affiliates. All rights reserved.
2+
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
3+
4+
# This workflow checks, builds, and tests all artifacts.
5+
6+
name: Build and Check
7+
on:
8+
pull_request:
9+
branches:
10+
- '*'
11+
types:
12+
- opened
13+
- reopened
14+
- synchronize
15+
- converted_to_draft
16+
push:
17+
branches:
18+
- main
19+
- release
20+
permissions:
21+
contents: read
22+
23+
jobs:
24+
build:
25+
runs-on: ubuntu-latest
26+
name: Build Artifact Verifier Plugins
27+
steps:
28+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
29+
30+
# Install Python to run pre-commit hooks for checking and linting GitHub Actions and other files.
31+
- name: Set up Python
32+
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
33+
with:
34+
python-version: '3.13'
35+
36+
- name: Check the code
37+
run: |
38+
pip install -r dev-requirements.txt
39+
pre-commit install
40+
pre-commit run --all-files
41+
42+
# Install Java.
43+
- name: Set up JDK 17
44+
uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1
45+
with:
46+
java-version: '17'
47+
distribution: temurin
48+
49+
# Build and test the artifacts.
50+
- name: Build the artifacts
51+
# TODO: Complete the run step.
52+
run: echo "TODO"
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Copyright (c) 2025 - 2025, Oracle and/or its affiliates. All rights reserved.
2+
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
3+
4+
# Run CodeQL over the package. For more configuration options see codeql/codeql-config.yaml
5+
# and: https://github.com/github/codeql-action
6+
7+
name: CodeQL
8+
on:
9+
push:
10+
branches:
11+
- main
12+
- release
13+
pull_request:
14+
branches:
15+
- main
16+
- release
17+
schedule:
18+
- cron: 20 15 * * 3
19+
permissions:
20+
contents: read
21+
22+
jobs:
23+
analyze:
24+
name: Analyze
25+
runs-on: ubuntu-latest
26+
permissions:
27+
actions: read
28+
contents: read
29+
security-events: write
30+
strategy:
31+
fail-fast: false
32+
matrix:
33+
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
34+
# Learn more about CodeQL language support at https://git.io/codeql-language-support
35+
# We enable JavaScript language to analyze JavaScript expressions in GitHub Actions.
36+
language: [Java, javascript]
37+
steps:
38+
39+
- name: Checkout repository
40+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
41+
42+
# Initializes the CodeQL tools for scanning.
43+
- name: Initialize CodeQL
44+
uses: github/codeql-action/init@4e828ff8d448a8a6e532957b1811f387a63867e8 # v3.29.4
45+
with:
46+
languages: ${{ matrix.language }}
47+
config-file: .github/codeql/codeql-config.yaml
48+
49+
# Uncomment the following section when repository is public. Advanced security, which is required
50+
# by CodeQL is not available for private repositories.
51+
# - name: Perform CodeQL Analysis
52+
# uses: github/codeql-action/analyze@4e828ff8d448a8a6e532957b1811f387a63867e8 # v3.29.4
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Copyright (c) 2025 - 2025, Oracle and/or its affiliates. All rights reserved.
2+
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
3+
4+
# This workflow lints the PR's title and commits. It uses the commitizen
5+
# package (https://github.com/commitizen-tools/commitizen) and its `cz`
6+
# tool to check the title of the PR and all commit messages of the branch
7+
# which triggers this Action.
8+
9+
name: Check conventional commits
10+
on:
11+
pull_request:
12+
branches:
13+
- '*'
14+
types:
15+
- opened
16+
- reopened
17+
- edited
18+
- synchronize
19+
permissions:
20+
contents: read
21+
22+
jobs:
23+
conventional-commits:
24+
runs-on: ubuntu-latest
25+
steps:
26+
27+
- name: Check out repository
28+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
29+
with:
30+
fetch-depth: 0
31+
32+
- name: Set up Python
33+
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
34+
with:
35+
python-version: '3.13'
36+
37+
# Prepare the environment and install dependencies.
38+
- name: Install dependencies
39+
run: pip install -r dev-requirements.txt
40+
41+
# Run Commitizen to check the title of the PR which triggered this workflow, and check
42+
# all commit messages of the PR's branch. If any of the checks fails then this job fails.
43+
- name: Check PR title
44+
run: echo "$PR_TITLE" | cz check
45+
env:
46+
PR_TITLE: ${{ github.event.pull_request.title }}
47+
- name: Check PR commit messages
48+
run: |
49+
git remote add other "$PR_HEAD_REPO_CLONE_URL"
50+
git fetch other
51+
cz check --rev-range "origin/$PR_BASE_REF..other/$PR_HEAD_REF"
52+
env:
53+
PR_BASE_REF: ${{ github.event.pull_request.base.ref }}
54+
PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}
55+
PR_HEAD_REPO_CLONE_URL: ${{ github.event.pull_request.head.repo.clone_url }}

0 commit comments

Comments
 (0)