Skip to content

feat: adding code and setup repository workflows #1

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

Closed
wants to merge 2 commits into from

Conversation

agustinfrancesa
Copy link
Contributor

No description provided.

@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@agustinfrancesa agustinfrancesa marked this pull request as draft June 12, 2025 17:28
@agustinfrancesa agustinfrancesa force-pushed the feat/setup branch 2 times, most recently from fc6bfeb to 12d8d7a Compare June 12, 2025 17:33
@agustinfrancesa agustinfrancesa requested a review from Copilot June 13, 2025 14:23
Copilot

This comment was marked as outdated.

@agustinfrancesa agustinfrancesa force-pushed the feat/setup branch 3 times, most recently from 52d89d3 to bb16141 Compare June 13, 2025 14:41
@agustinfrancesa agustinfrancesa requested a review from Copilot June 13, 2025 14:42
Copilot

This comment was marked as outdated.

@agustinfrancesa agustinfrancesa requested a review from Copilot June 13, 2025 14:55
Copilot

This comment was marked as outdated.

agustinfrancesa and others added 2 commits June 13, 2025 08:58
Signed-off-by: Francesa Alfaro, Agustin <agustin.francesa.alfaro@intel.com>
Signed-off-by: Erin Olmon <erin.olmon@intel.com>
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds new documentation content for various design components and setup instructions while integrating repository workflows for automated builds, semantic releases, security scans, and dependency management.

  • New documentation pages for components such as cards, blocks, API, and admonitions
  • Contributor guide updates and configuration file (conf.py) adjustments
  • Workflow files for semantic-release, build checks, Bandit scans, and Dependabot

Reviewed Changes

Copilot reviewed 183 out of 183 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/custom-content/* Added documentation examples for components and design
docs/contributor-guide/* New contributor setup and guide instructions
docs/conf.py Updated Sphinx configuration including html_context
docs/_static/* Added static assets and redirects for theme switching
docs/README.md, docs/Makefile, README.md, MANIFEST.in, LICENSE.md, CONTRIBUTING.md, CHANGELOG.md Documentation and repository metadata updates
.github/workflows/* New workflows for semantic release, build checks, Bandit, and Dependabot

Comment on lines +54 to +60
html_context = {
"color_scheme": "tb",
}
else:
html_context = {
"color_scheme": "default",
}
Copy link
Preview

Copilot AI Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The html_context variable is reassigned multiple times, which may override previous settings unintentionally. Consider consolidating the context updates using html_context.update() to improve clarity and maintainability.

Suggested change
html_context = {
"color_scheme": "tb",
}
else:
html_context = {
"color_scheme": "default",
}
html_context.update({
"color_scheme": "tb",
})
else:
html_context.update({
"color_scheme": "default",
})

Copilot uses AI. Check for mistakes.

Comment on lines +32 to +43
shell: python
run: |
import os
import subprocess

def build_wheel():
if not os.path.exists('dist'):
os.makedirs('dist')
subprocess.check_call([ 'python', '-m', 'build', '--wheel' ])

build_wheel()

Copy link
Preview

Copilot AI Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Using 'shell: python' in the Build step is unconventional. Consider using a standard shell (e.g., bash) to run a Python script with 'python -c' to ensure compatibility and clarity.

Suggested change
shell: python
run: |
import os
import subprocess
def build_wheel():
if not os.path.exists('dist'):
os.makedirs('dist')
subprocess.check_call([ 'python', '-m', 'build', '--wheel' ])
build_wheel()
shell: bash
run: |
python -c "
import os;
import subprocess;
if not os.path.exists('dist'):
os.makedirs('dist');
subprocess.check_call(['python', '-m', 'build', '--wheel']);
"

Copilot uses AI. Check for mistakes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants