Skip to content

Commit

Permalink
Initial commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
scottstraughan committed Jul 8, 2024
0 parents commit cded1b0
Show file tree
Hide file tree
Showing 845 changed files with 13,370 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
version: 2

updates:
- package-ecosystem: 'pip'
directory: ''/'
schedule:
interval: 'weekly'
59 changes: 59 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: 'CodeQL'

on:
push:
branches: [ 'main' ]
pull_request:
branches: [ 'main' ]
schedule:
- cron: '44 3 * * 3'
workflow_dispatch:

# Declare default permissions as read only.
permissions:
contents: read

jobs:
analyze:
name: Analyze (${{ matrix.language }})
# Runner size impacts CodeQL analysis time. To learn more, please see:
# - https://gh.io/recommended-hardware-resources-for-running-codeql
# - https://gh.io/supported-runners-and-hardware-resources
# - https://gh.io/using-larger-runners (GitHub.com only)
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
runs-on: 'ubuntu-latest'
timeout-minutes: 360
permissions:
security-events: write
packages: read

strategy:
fail-fast: false
matrix:
include:
- language: python
build-mode: none
steps:
- name: Checkout repository
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332

- name: Initialize CodeQL
uses: github/codeql-action/init@b611370bb5703a7efb587f9d136a52ea24c5c38c
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}

- if: matrix.build-mode == 'manual'
shell: bash
run: |
echo 'If you are using a "manual" build mode for one or more of the' \
'languages you are analyzing, replace this with the commands to build' \
'your code, for example:'
echo ' make bootstrap'
echo ' make release'
exit 1
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@b611370bb5703a7efb587f9d136a52ea24c5c38c
with:
category: "/language:${{matrix.language}}"
71 changes: 71 additions & 0 deletions .github/workflows/generate.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Generate JSON Feeds

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

permissions:
contents: read
pages: write
id-token: write

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
- name: Set up Python 3.11
uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d
with:
python-version: '3.11'
cache: 'pip'
- name: Install Dependencies
run: pip install -r requirements.txt --require-hashes --no-deps
- name: Generate Feeds
run: |
# Generate the JSON Feeds
python feed.py \
-s "${{ vars.CI_PAGES_URL }}" \
-a "${{ vars.CI_PAGES_URL }}/static/" \
-b "${{ vars.CI_PAGES_URL }}/feed" \
-g "${{ secrets.FRONT_END_REBUILD_TOKEN }}"
- name: Copy Generate Feeds
run: |
cp -R html/. static feed/
- name: Upload Feeds as Artifacts
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa
with:
path: ./feed

# Deployment job
deploy:
if: (github.event_name == 'push'
&& github.ref_name == 'main') || github.event_name == 'workflow_dispatch'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
outputs:
REBUILD_FRONT_END: ${{ env.REBUILD_FRONT_END }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e

# Trigger the front-end to rebuild
rebuild-frontend:
needs: deploy
runs-on: ubuntu-latest
steps:
- name: Build Front-End
uses: convictional/trigger-workflow-and-wait@924e4984551efec603bec665c0663332498c381a
with:
owner: codeplaysoftware
repo: sycl.tech-website
github_token: ${{ secrets.SYCL_TECH_SYNC_TOKEN }}
workflow_file_name: build.yml
45 changes: 45 additions & 0 deletions .github/workflows/scorecard.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Scorecard Supply-Chain Security

on:
branch_protection_rule:
schedule:
- cron: '27 15 * * 0'
push:
branches: [ 'main' ]
workflow_dispatch:

# Declare default permissions as read only.
permissions: read-all

jobs:
analysis:
name: Scorecard analysis
runs-on: ubuntu-latest
permissions:
security-events: write
id-token: write

steps:
- name: 'Checkout Code'
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
persist-credentials: false

- name: 'Run Analysis'
uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1
with:
results_file: results.sarif
results_format: sarif
publish_results: true

- name: 'Upload Artifact'
uses: actions/upload-artifact@97a0fba1372883ab732affbe8f94b823f91727db # v3.pre.node20
with:
name: SARIF file
path: results.sarif
retention-days: 5

- name: 'Upload to Code-Scanning'
uses: github/codeql-action/upload-sarif@1b1aada464948af03b950897e5eb522f92603cc2 # v3.24.9
with:
sarif_file: results.sarif
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.venv
.idea
feed
__pycache__
.DS_Store
61 changes: 61 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
disability, ethnicity, sex characteristics, gender identity and expression , level of experience, education,
socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

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

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers 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, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the
project or its community in public spaces. Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting as an appointed representative at an
online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team
at <[email protected]>. All complaints will be reviewed and investigated and will result in a response that is deemed
necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to
the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

---

If there are any issues or suggestions relating to the current set of rules, you can reach us at <[email protected]>.
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Contributing to sycl.tech Content

## Pull requests

We really appreciate all pull requests to this project, but we also have a few guidelines in place to help keep the
project consistent and reduce the noise in commits, pull requests and code. Hopefully these guidelines are clear and
easy to follow, if not then feel free to add an issue to address this.

Before starting any development please make an issue to communicate your intent and ensure that you are not duplicating
work.

### Formatting

Please ensure that any contributions are formatted using the following guidelines:

* Empty line at the end of each plaintext file
* Use "LF" line endings
* Use 2 character spaces as much as possible
* Following the naming conventions of the files currently in the repository
* For images, webp is preferred although for larger images you can use JPEG.
* For source files, a line length of 120 is encouraged
* Following the same formatting as currently in use

### Pull request guidelines

* Submit any pull request to the `main` branch, unless you are really sure you need to push your changes elsewhere.

* Unless your pull request is trivial, expect comments and suggestions on your pull request. We will provide feedback as
soon as possible.

* We cannot accept or test any pull request with merge conflicts, so please fix these before submitting your pull
request.

* Please ensure pull requests are small and focussed. This means that they should only address a single feature, change
or bug fix. Larger pull requests trying to fix multiple things at once should be split into smaller pull requests.

* All tests must pass before a pull request is accepted.

* If your pull request adds a new feature, please make sure that you add new test cases to cover this feature.

### Commit guidelines

* In your commit messages, the first line should be a short summary of the changes. Following this should be an empty
line, then the remaining commit message explaining the changes in more detail.

* Use the present tense to say what the commit changes.

* Check for any unnecessary whitespace changes with `git diff --check` before committing your changes.
Loading

0 comments on commit cded1b0

Please sign in to comment.