TypeScript API client for autograder.io. Can be installed via npm:
npm install ag-client-typescript
Requires Ubuntu 20.04 or later and Node 16 (newer versions might work).
git clone --recursive https://github.com/eecs-autograder/ag-client-typescript.git
If you forgot the --recursive flag, initialize the submodule with:
git submodule update --init
You'll also need to rerun this command after pulling repository updates.
If you are updating this library to include new changes to the autograder-server code, make sure the autograder-server submodule is up to date:
git submodule update --remote
Add and commit the autograder-server changes:
git add autograder-server
git commit
Ubuntu: https://docs.docker.com/install/linux/docker-ce/ubuntu/#install-docker-ce-1
First, install Python 3.10
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get update
sudo apt-get install python3.10 python3.10-distutils python3.10-venv
curl https://bootstrap.pypa.io/get-pip.py | sudo python3.10
python3.10 -m venv venv
source venv/bin/activate
Next, install the minimum dependencies needed to run generate_secrets.py:
python -m pip install --upgrade pip
python -m pip install Django==3.1 python-gnupg
Run the script:
cd autograder-server && python3 generate_secrets.py
docker compose build
docker compose up -d
docker ps
docker exec -it typescript-cli-django python3 manage.py migrate
npm ci
Note: If you ran npm run build (for publishing new package versions), you will need to delete the "dist" folder, otherwise the linter will read the stale .d.ts files instead of the updated .ts files in the src directory.
Run the linters and test suite:
npm run lint
npm test
This package uses calendar versioning following Python conventions, with version numbers of the form yyyy.mm.X, where X is for minor versions.
For example: 2024.08.0 corresponds to August 2024.
We also make use of pre-release modifiers such as .devX.
For consistency across Autograder.io's modules, pre-release modifiers will start with a dot (e.g., .devX) in Git tags.
In package.json and package-lock.json, pre-release modifiers will start with a hyphen (e.g., -devX) because npm requires this format.
Note that npm version will also strip leading zeros from the version.
Include them anyway when triggering a workflow_dispatch event so that the branch and tag names are zero-padded.
Use feature branches for all changes, and make a pull request against the develop branch.
The develop branch is for changes based on the develop branch of the autograder-server repo (which is a submodule of this repo found at tests/local_stack/autograder-server).
Update the submodule develop branch when starting work on a feature that depends on new autograder-server commits.
Use the following steps on your feature branch:
# Fetch latest submodule commits
git submodule update --remote
# git status should show new commits in the submodule
git status
git add tests/local_stack/autograder-server
git commit -m "Update submodule"
Name release branches as release-YYYY.MM.x, replacing YYYY with the full year and MM with the zero padded month (e.g., release-2024.08.x).
IMPORTANT: When you create a release branch, update the branch field in the autograder-server entry of .gitmodules to point to the corresponding release branch in the autograder-server submodule.
Then run git submodule update --remote and commit the changes.
Do NOT merge or rebase directly between the develop and release branches.
Once a release branch is created, it should only be updated with bugfix- or (rarely) feature-style branches.
Squash-and-merge for this type of PR.
After the squashed branch is merged into a release branch, cherry-pick the squashed commit on top of develop and open a pull request to merge the changes into develop.
The version of README.md (this file) on the develop branch is the source of truth.
Update this file on release branches just before publishing a release.
If instructions differ across releases, include both, and label which version the instructions apply to.
To create a github release, trigger a workflow_dispatch event on the release branch.
Pass the version number as input.
CI will update the version number, lint and test the module, tag the release, and create a GitHub release. At time of writing, the workflow does not publish to NPM
Note that npm version will strip leading zeros from the version numbers written to package*.json.
Include them anyway when triggering a workflow_dispatch event so that the branch and tag names are zero-padded.