Skip to content

Commit

Permalink
New: automated release added to the repo (fixes #4)
Browse files Browse the repository at this point in the history
  • Loading branch information
swashbuck authored Sep 28, 2023
2 parents 74e7a0a + 962aa5b commit b21ac50
Show file tree
Hide file tree
Showing 9 changed files with 10,534 additions and 10 deletions.
8 changes: 8 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
We heartily welcome contributions to the Adapt project source code and community.
Here is a list of resources you may find useful:

* [Contributing to the Adapt project documentation](https://github.com/adaptlearning/adapt_framework/wiki/Contributing-to-the-Adapt-Project)
* [The Adapt framework wiki](https://github.com/adaptlearning/adapt_framework/wiki)
* [Gitter chat room](https://gitter.im/adaptlearning/adapt_framework)
* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### Subject of the issue/enhancement/features
Describe your issue here.

### Your environment
* version (AT/Framework)
* which browser and its version
* device(s) + operating system(s)

### Steps to reproduce
Tell us how to reproduce this issue.

### Expected behaviour
Tell us what should happen

### Actual behaviour
Tell us what happens instead

### Screenshots (if you can)
25 changes: 25 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[//]: # (Please title your PR according to eslint commit conventions)
[//]: # (See https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint#eslint-convention for details)

[//]: # (Link the PR to the original issue)

[//]: # (Delete Fix, Update, New and/or Breaking sections as appropriate)
### Fix
* A sentence describing each fix

### Update
* A sentence describing each udpate

### New
* A sentence describing each new feature

### Breaking
* A sentence describing each breaking change

[//]: # (List appropriate steps for testing if needed)
### Testing
1. Steps for testing

[//]: # (Mention any other dependencies)


19 changes: 19 additions & 0 deletions .github/workflows/addtomainproject.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Add to main project

on:
issues:
types:
- opened
pull_request:
types:
- opened

jobs:
add-to-project:
name: Add to main project
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
with:
project-url: https://github.com/orgs/cgkineo/projects/3/views/1
github-token: ${{ secrets.ADDTOPROJECT_TOKEN }}
25 changes: 25 additions & 0 deletions .github/workflows/releases.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Release
on:
push:
branches:
- master
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Setup Node.js
uses: actions/setup-node@v2
with:
node-version: 'lts/*'
- name: Install dependencies
run: npm ci
- name: Release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: npx semantic-release
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,18 @@
* failed
* passed

The 'incomplete' image is only needed if the Assessment Results Graphic can been seen by the learner prior to assessment completion i.e. it hasn't been hidden either by the Trickle extension or by using `_isVisibleBeforeCompletion: false` - otherwise it can safely be left out.
The `_assessmentIncomplete` image is only needed if the Assessment Results Graphic can been seen by the learner prior to assessment completion (i.e. it hasn't been hidden either by the Trickle extension or by using `_isVisibleBeforeCompletion: false`). Otherwise, it can safely be left out.

You *must* specify both the failed and passed images. If you don't want to have a different graphic for each of those assessment states you should probably just be using the standard graphic component..!
You *must* specify both the failed and passed images (`_assessmentFailed` and `_assessmentPassed`). If you don't want to have a different graphic for each of those assessment states, you should probably just be using the standard Graphic component.

It is expected that most of the time this component will have `_isOptional: true` - but if not, it does support the same `_setCompletionOn` settings as the Assessment Results component.
It is expected that most of the time this component will have `_isOptional: true`. If it is _not_ optional, it does support the same `_setCompletionOn` settings as the Assessment Results component.

## Limitations
Hasn't yet had a properties.schema added and set up - so isn't Adapt Authoring Tool compatible.
Hasn't yet had schemas added and set up, so it isn't Adapt Authoring Tool compatible.

----------------------------
**Version number:** 0.0.1
**Framework versions:** 5+
**Author / maintainer:** Kineo
**Accessibility support:** Yes
**RTL support:** Yes
**Cross-platform coverage:** Chrome, Chrome for Android, Firefox (ESR + latest version), Edge, IE11, Safari 13+14 for macOS/iOS/iPadOS, Opera
**Framework versions:** 5+<br>
**Author / maintainer:** Kineo<br>
**Accessibility support:** Yes<br>
**RTL support:** Yes<br>
**Cross-platform coverage:** Chrome, Chrome for Android, Firefox (ESR + latest version), Edge, IE11, Safari 13+14 for macOS/iOS/iPadOS, Opera<br>
Loading

0 comments on commit b21ac50

Please sign in to comment.