Skip to content

Commit

Permalink
Merge pull request #13 from fraya/master
Browse files Browse the repository at this point in the history
Refurbish library
  • Loading branch information
fraya authored Apr 11, 2024
2 parents c10d8b6 + 5cad3a1 commit 5bdfd81
Show file tree
Hide file tree
Showing 13 changed files with 176 additions and 10 deletions.
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

version: 2
updates:
- package-ecosystem: "github-actions" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
54 changes: 54 additions & 0 deletions .github/workflows/buid-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Build documentation

on:
push:
# all branches

# This enables the Run Workflow button on the Actions tab.
workflow_dispatch:

# https://github.com/JamesIves/github-pages-deploy-action#readme
permissions:
contents: write

# Set DYLAN environment variable to GITHUB_WORKSPACE so packages are
# installed in ../../_packages relative to documentation's Makefile
env:
DYLAN: ${{ github.workspace }}

jobs:

build-and-deploy:
runs-on: ubuntu-latest
steps:

- name: Checkout code
uses: actions/checkout@v4

- name: Check links
uses: addnab/docker-run-action@v3
with:
image: ghcr.io/fraya/dylan-docs
options: -v ${{ github.workspace }}/documentation:/docs
run: make linkcheck

- name: Build docs with Furo theme
uses: addnab/docker-run-action@v3
with:
image: ghcr.io/fraya/dylan-docs
options: -v ${{ github.workspace }}/documentation:/docs
run: make html

- name: Upload html artifact
uses: actions/upload-artifact@v4
with:
name: collection-extensions-github-io-html
path: documentation/build/html/

- name: Bypassing Jekyll on GH Pages
run: sudo touch documentation/build/html/.nojekyll

- name: Deploy docs to GH pages
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: documentation/build/html
35 changes: 35 additions & 0 deletions .github/workflows/build-and-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Build and test

on:
push:
# all branches
pull_request:
# all branches

# This enables the Run Workflow button on the Actions tab.
workflow_dispatch:

jobs:
build-and-test:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Install Opendylan
uses: dylan-lang/install-opendylan@v3

- name: Download dependencies
run: dylan update

- name: Build tests
run: dylan build collection-extensions-test-suite-app

- name: Run tests
run: _build/bin/collection-extensions-test-suite-app --progress none --report surefire > _build/TEST-collection-extensions.xml

- name: Publish Test Report
if: success() || failure()
uses: mikepenz/action-junit-report@v4
with:
report_paths: '**/_build/TEST-*.xml'
19 changes: 18 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
# backup files
*~
*.bak
.DS_Store

# project file
*.hdp
_build

# documentation build directory
build/

# compiler build directory
_build/

# dylan tool package cache
_packages/

# package registry folder
registry/
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Copyright.

Copyright (C) 2004 Dr. Matthias Hölzl.

Use and copying of this software and preparation of derivative works
based on this software are permitted, including commercial use,
provided that the following conditions are observed:

1. This copyright notice must be retained in full on any copies and on
appropriate parts of any derivative works. (Other names and years
may be added, so long as no existing ones are removed.)

This software is made available "as is". Neither the authors nor
Carnegie Mellon University make any warranty about the software, its
performance, or its conformity to any specification.

Bug reports, questions, comments, and suggestions should be sent by
E-mail to the Internet address "[email protected]".

If you need to receive this library under another license contact the
author ([email protected]).
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Collection extensions
[![Build and test](https://github.com/dylan-lang/collection-extensions/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/dylan-lang/collection-extensions/actions/workflows/build-and-test.yml) [![Build documentation](https://github.com/dylan-lang/collection-extensions/actions/workflows/buid-documentation.yml/badge.svg)](https://github.com/dylan-lang/collection-extensions/actions/workflows/buid-documentation.yml)

Collection library for Dylan

## Classes included

- collection-utilities
- heap
- sde-vector
- self-organizing-list
- sequence-diff
- sequence-utilities
- subseq
- vector-search
7 changes: 5 additions & 2 deletions documentation/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

import os
import sys
sys.path.insert(0, os.path.abspath('../../ext/sphinx-extensions/sphinxcontrib'))
sys.path.insert(0, os.path.abspath('../../_packages/sphinx-extensions/current/src/sphinxcontrib'))
import dylan.themes as dylan_themes


Expand Down Expand Up @@ -53,7 +53,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = dylan_themes.get_html_theme_default()
html_theme = 'furo'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand All @@ -71,3 +71,6 @@
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Ignore certification verification
tls_verify = False
17 changes: 17 additions & 0 deletions dylan-package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"category": "utilities",
"contact": "[email protected]",
"description": "Collection library",
"keywords": [
"heap", "list", "search", "sequence", "subsequence", "vector", "collections"
],
"name": "collection-extensions",
"dependencies": [],
"dev-dependencies": [
"[email protected]",
"[email protected]"
],
"license": "MIT",
"url": "https://github.com/dylan-lang/collection-extensions",
"version": "0.2.0"
}
1 change: 0 additions & 1 deletion ext/sphinx-extensions
Submodule sphinx-extensions deleted from 333fdd
1 change: 0 additions & 1 deletion registry/generic/collection-extensions

This file was deleted.

1 change: 0 additions & 1 deletion registry/generic/collection-extensions-test-suite

This file was deleted.

1 change: 0 additions & 1 deletion registry/generic/collection-extensions-test-suite-app

This file was deleted.

0 comments on commit 5bdfd81

Please sign in to comment.