Skip to content

Commit

Permalink
Fix: Added release automation
Browse files Browse the repository at this point in the history
  • Loading branch information
joe-allen-89 committed Feb 14, 2023
1 parent fdfaca3 commit 5e4bbfc
Show file tree
Hide file tree
Showing 9 changed files with 10,576 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 @@ -32,7 +32,7 @@ Text displayed when no results are found, defaults to `"Sorry, no results were f
### awaitingResultsMessage (string):
Message between having enough characters to search and having search results (More than 2 characters per word). Defaults to `"Formulating results..."`.

### \_showHighlights (boolean):
### \_showHighlights (boolean):
Show the yellow highlights on search results. Defaults to `true`.

### \_showFoundWords (boolean):
Expand All @@ -47,13 +47,13 @@ If the number of `_previewWords` cannot be found then use `x` number of characte
## Item Attributes
The attributes listed below are used in *contentObject.json*, *articles.json*, *blocks.json* and *components.json* to configure **Search Items**, and are properly formatted as JSON in [*example.json*](https://github.com/cgkineo/adapt-search/blob/master/example.json).

### \_search (object):
### \_search (object):
Container object for the `keywords` setting

### \title (string):
### \title (string):
Alternative title for search result.

#### keywords (array):
#### keywords (array):
A list of search keywords/phrases to be associated with the contentObject/article/block/component. Each item in the array must be a string.
**NOTE**: Keywords are exported with the `grunt translate:export` command. When localising content, use a process that ensures translated keywords are found in the actual translated course content.

Expand All @@ -63,9 +63,8 @@ A list of search keywords/phrases to be associated with the contentObject/articl
No known limitations.

----------------------------
**Version number:** 4.2.1 <a href="https://community.adaptlearning.org/" target="_blank"><img src="https://github.com/adaptlearning/documentation/blob/master/04_wiki_assets/plug-ins/images/adapt-logo-mrgn-lft.jpg" alt="adapt learning logo" align="right"></a>
**Framework versions:** 5.8+
**Author / maintainer:** Kineo and community with [contributors](https://github.com/cgkineo/adapt-search/graphs/contributors)
**Accessibility support:** WAI AA
**RTL support:** No
**Cross-platform coverage:** Chrome, Chrome for Android, Firefox (ESR + latest version), Edge, IE11, Safari 14 for macOS/iOS/iPadOS, Opera
<a href="https://community.adaptlearning.org/" target="_blank"><img src="https://github.com/adaptlearning/documentation/blob/master/04_wiki_assets/plug-ins/images/adapt-logo-mrgn-lft.jpg" alt="adapt learning logo" align="right"></a>
**Author / maintainer:** Kineo and community with [contributors](https://github.com/cgkineo/adapt-search/graphs/contributors)
**Accessibility support:** WAI AA
**RTL support:** No
**Cross-platform coverage:** Chrome, Chrome for Android, Firefox (ESR + latest version), Edge, IE11, Safari 14 for macOS/iOS/iPadOS, Opera
Loading

0 comments on commit 5e4bbfc

Please sign in to comment.