Merge pull request #58 from TU-Wien-dataLAB/release-0.6.0

Release 0.6.0

.copier-answers.yml

@@ -1,20 +1,15 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: v4.2.4
+_commit: v4.3.5
 _src_path: https://github.com/jupyterlab/extension-template
 author_email: [email protected]
-author_name: Florian Jaeger
-data_format: string
-file_extension: ''
+author_name: Florian Jaeger, Marijana Petojevic, Matthias Matt
 has_binder: true
 has_settings: true
 kind: server
 labextension_name: grader-labextension
-mimetype: ''
-mimetype_name: ''
 project_short_description: Grader Labextension is a JupyterLab extension to enable
     automatic grading of assignment notebooks.
 python_name: grader_labextension
-repository: https://github.com/TU-Wien-dataLAB/Grader-Labextension
+repository: https://github.com/TU-Wien-dataLAB/grader-labextension
 test: true
-viewer_name: ''
 

.github/workflows/build.yml

@@ -44,4 +44,4 @@ jobs:
         retention-days: 1
         path: |
           ./dist
-          !./dist/**/*.md
+          !./dist/**/*.md

.gitignore

@@ -1,3 +1,4 @@
+.vscode/
 *.bundle.*
 lib/
 node_modules/
@@ -15,6 +16,11 @@ grader_labextension/_version.py
 ui-tests/test-results/
 ui-tests/playwright-report/
 
+
+jupyterhub_cookie_secret
+jupyterhub-proxy.pid
+jupyterhub.sqlite
+
 # Created by https://www.gitignore.io/api/python
 # Edit at https://www.gitignore.io/?templates=python
 

Dockerfile

@@ -6,7 +6,7 @@
 
 ARG REGISTRY=quay.io
 ARG OWNER=jupyter
-ARG BASE_CONTAINER=$REGISTRY/$OWNER/datascience-notebook
+ARG BASE_CONTAINER=$REGISTRY/$OWNER/datascience-notebook:latest
 FROM $BASE_CONTAINER
 
 USER root
@@ -18,10 +18,11 @@ RUN apt-get update &&\
 RUN apt-get clean && \
     rm -rf /var/lib/apt/lists/*
 
-COPY ./ /Grader-Labextension
+COPY ./ /grader-labextension
 
-RUN python3 -m pip install /Grader-Labextension
-RUN rm -rf /Grader-Labextension
+RUN mamba install nodejs
+RUN python3 -m pip install /grader-labextension
+RUN rm -rf /grader-labextension
 
 WORKDIR /home/jovyan
 

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2024, Florian Jaeger
+Copyright (c) 2024, Florian Jaeger, Marijana Petojevic, Matthias Matt
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,6 +1,9 @@
 # grader_labextension
 
-[![Github Actions Status](https://github.com/TU-Wien-dataLAB/Grader-Labextension/workflows/Build/badge.svg)](https://github.com/TU-Wien-dataLAB/Grader-Labextension/actions/workflows/build.yml)[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/TU-Wien-dataLAB/Grader-Labextension/main?urlpath=lab)
+[![Github Actions Status](https://github.com/TU-Wien-dataLAB/grader-labextension/workflows/Build/badge.svg)](https://github.com/TU-Wien-dataLAB/grader-labextension/actions/workflows/build.yml)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/TU-Wien-dataLAB/grader-labextension/main?urlpath=lab)
+
+
 Grader Labextension is a JupyterLab extension to enable automatic grading of assignment notebooks.
 
 This extension is composed of a Python package named `grader_labextension`

RELEASE.md

@@ -58,52 +58,21 @@ npm publish --access public
 
 ## Automated releases with the Jupyter Releaser
 
-The extension repository should already be compatible with the Jupyter Releaser.
-
-Check out the [workflow documentation](https://jupyter-releaser.readthedocs.io/en/latest/get_started/making_release_from_repo.html) for more information.
+The extension repository should already be compatible with the Jupyter Releaser. But
+the GitHub repository and the package managers need to be properly set up. Please
+follow the instructions of the Jupyter Releaser [checklist](https://jupyter-releaser.readthedocs.io/en/latest/how_to_guides/convert_repo_from_repo.html).
 
 Here is a summary of the steps to cut a new release:
 
-- Add tokens to the [Github Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) in the repository:
-  - `ADMIN_GITHUB_TOKEN` (with "public_repo" and "repo:status" permissions); see the [documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
-  - `NPM_TOKEN` (with "automation" permission); see the [documentation](https://docs.npmjs.com/creating-and-viewing-access-tokens)
-- Set up PyPI
-
-<details><summary>Using PyPI trusted publisher (modern way)</summary>
-
-- Set up your PyPI project by [adding a trusted publisher](https://docs.pypi.org/trusted-publishers/adding-a-publisher/)
-  - The _workflow name_ is `publish-release.yml` and the _environment_ should be left blank.
-- Ensure the publish release job as `permissions`: `id-token : write` (see the [documentation](https://docs.pypi.org/trusted-publishers/using-a-publisher/))
-
-</details>
-
-<details><summary>Using PyPI token (legacy way)</summary>
-
-- If the repo generates PyPI release(s), create a scoped PyPI [token](https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#saving-credentials-on-github). We recommend using a scoped token for security reasons.
-
-- You can store the token as `PYPI_TOKEN` in your fork's `Secrets`.
-
-  - Advanced usage: if you are releasing multiple repos, you can create a secret named `PYPI_TOKEN_MAP` instead of `PYPI_TOKEN` that is formatted as follows:
-
-    ```text
-    owner1/repo1,token1
-    owner2/repo2,token2
-    ```
-
-    If you have multiple Python packages in the same repository, you can point to them as follows:
-
-    ```text
-    owner1/repo1/path/to/package1,token1
-    owner1/repo1/path/to/package2,token2
-    ```
-
-</details>
-
 - Go to the Actions panel
 - Run the "Step 1: Prep Release" workflow
 - Check the draft changelog
 - Run the "Step 2: Publish Release" workflow
 
+> [!NOTE]
+> Check out the [workflow documentation](https://jupyter-releaser.readthedocs.io/en/latest/get_started/making_release_from_repo.html)
+> for more information.
+
 ## Publishing to `conda-forge`
 
 If the package is not on conda forge yet, check the documentation to learn how to add it: https://conda-forge.org/docs/maintainer/adding_pkgs.html