Skip to content

Commit

Permalink
chore: add catalog-info.yaml (#13)
Browse files Browse the repository at this point in the history
This also includes a small readme update.
---------

Co-authored-by: Feanil Patel <[email protected]>
  • Loading branch information
MoisesGSalas and feanil authored May 22, 2024
1 parent defc5bb commit 3395b99
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 4 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ jobs:

- name: Run coverage
if: matrix.python-version == '3.8' && matrix.toxenv == 'py38'
uses: codecov/codecov-action@v3
uses: codecov/codecov-action@v4
with:
flags: unittests
fail_ci_if_error: true
token: ${{ secrets.CODECOV_TOKEN }}
13 changes: 10 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
codejail-includes
=============================
=================

|pypi-badge| |license-badge|

CodeJail manages execution of untrusted code in secure sandboxes. It is designed primarily for Python execution,
but can be used for other languages as well.

A set of utility modules available in secure sandboxes for course authors to
use.

``codejail-includes`` is the result of extracting utility modules installed
into the codejail sandbox environment directly from edx-platform into it's
own separate package.

More in-depth context can be found in `[BOM-2579] Dissolve Sub-Projects in edx-platform <https://openedx.atlassian.net/browse/BOM-2579>`_

Documentation
-------------
Expand Down
12 changes: 12 additions & 0 deletions catalog-info.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: codejail-includes
description: A set of utility modules available in the sandbox environment for course authors to use.
annotations:
openedx.org/arch-interest-groups: moisesgsalas
spec:
owner: user:moisesgsalas
type: library
lifecycle: production
subcomponentOf: codejail

0 comments on commit 3395b99

Please sign in to comment.