Skip to content

Commit

Permalink
Merge branch 'develop' into dependabot/npm_and_yarn/xmldom/xmldom-0.7.6
Browse files Browse the repository at this point in the history
  • Loading branch information
billy clark authored Oct 18, 2022
2 parents 8e9780e + 4d9114f commit 77a6321
Show file tree
Hide file tree
Showing 301 changed files with 17,946 additions and 14,686 deletions.
53 changes: 25 additions & 28 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,42 +1,39 @@
// If you want to run as a non-root user in the container, see .devcontainer/docker-compose.yml.
{
"name": "Existing Docker Compose (Extend)",
"name": "Existing Docker Compose (Extend)",

// Update the 'dockerComposeFile' list if you have more compose files or use different names.
// The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
"dockerComposeFile": [
"../docker/docker-compose.yml",
"docker-compose.yml"
],
// Update the 'dockerComposeFile' list if you have more compose files or use different names.
// The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
"dockerComposeFile": ["../docker/docker-compose.yml", "docker-compose.yml"],

// The 'service' property is the name of the service for the container that VS Code should
// use. Update this value and .devcontainer/docker-compose.yml to the real service name.
"service": "test-e2e",
// The 'service' property is the name of the service for the container that VS Code should
// use. Update this value and .devcontainer/docker-compose.yml to the real service name.
"service": "test-e2e",

// The optional 'workspaceFolder' property is the path VS Code should open by default when
// connected. This is typically a file mount in .devcontainer/docker-compose.yml
"workspaceFolder": "/data",
// The optional 'workspaceFolder' property is the path VS Code should open by default when
// connected. This is typically a file mount in .devcontainer/docker-compose.yml
"workspaceFolder": "/data",

// Set *default* container specific settings.json values on container create.
"settings": {},
// Set *default* container specific settings.json values on container create.
"settings": {},

// Add the IDs of extensions you want installed when the container is created.
"extensions": [],
// Add the IDs of extensions you want installed when the container is created.
"extensions": [],

// Use 'forwardPorts' to make a list of ports inside the container available locally.
"forwardPorts": [9229],
// Use 'forwardPorts' to make a list of ports inside the container available locally.
"forwardPorts": [9229],

// Uncomment the next line if you want start specific services in your Docker Compose config.
// "runServices": [],
// Uncomment the next line if you want start specific services in your Docker Compose config.
// "runServices": [],

// Uncomment the next line if you want to keep your containers running after VS Code shuts down.
// "shutdownAction": "none",
// Uncomment the next line if you want to keep your containers running after VS Code shuts down.
// "shutdownAction": "none",

"initializeCommand": "cd docker && docker-compose build --build-arg ENVIRONMENT=development app && docker-compose build --build-arg ENVIRONMENT=development app-for-e2e test-e2e && docker-compose up -d app-for-e2e",
"initializeCommand": "cd docker && docker-compose build --build-arg ENVIRONMENT=development app && docker-compose build --build-arg ENVIRONMENT=development app-for-e2e test-e2e && docker-compose up -d app-for-e2e",

// Uncomment the next line to run commands after the container is created - for example installing docker.
"onCreateCommand": "apk add docker",
// Uncomment the next line to run commands after the container is created - for example installing docker.
"onCreateCommand": "apk add docker"

// Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
// "remoteUser": "vscode"
// Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
// "remoteUser": "vscode"
}
20 changes: 11 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
name: Bug report
about: Create a report to help us improve
title: 'bug: '
assignees: ''

title: "bug: "
assignees: ""
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
Expand All @@ -23,16 +23,18 @@ A clear and concise description of what you expected to happen.
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]

**Mobile (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]

**Android App in Google Play**
For Mobile, are you using the Language Forge Android app in the Google Play store? [Yes/No]
For Mobile, are you using the Language Forge Android app in the Google Play store? [Yes/No]

**Additional context**
Add any other context about the problem here.
5 changes: 2 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
name: Feature request
about: Suggest an idea for this project
title: 'feat: '
assignees: ''

title: "feat: "
assignees: ""
---

**Is your feature request related to a problem? Please describe.**
Expand Down
10 changes: 4 additions & 6 deletions .github/ISSUE_TEMPLATE/send-receive-with-flex.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
---
name: Send/Receive with FLEx
about: Report a problem syncing your project
title: ''
labels: ''
assignees: ''

title: ""
labels: ""
assignees: ""
---

If your project has been put on hold and you want to keep the details of your project private, please email languageforgeissues@sil.org with the following information.

The Language Forge project is run as an open-source and open-issue-tracker project, meaning that all our code and issues are publicly available on the internet. Please do not include any sensitive information (passwords, names, locations, etc.) in this issue report.

The Language Forge project is run as an open-source and open-issue-tracker project, meaning that all our code and issues are publicly available on the internet. Please do not include any sensitive information (passwords, names, locations, etc.) in this issue report.

Project name:

Expand Down
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Only keep lines below that describe this change, then delete the rest.

## Screenshots

Please provide screenshots / animations for any change that involves the UI. Please provide animations to demonstrate user interaction / behavior changes
Please provide screenshots / animations for any change that involves the UI. Please provide animations to demonstrate user interaction / behavior changes

## Checklist

Expand All @@ -28,7 +28,7 @@ Please provide screenshots / animations for any change that involves the UI. Pl

## How to test

Please describe how to test and/or verify your changes. Provide instructions so we can reproduce. Please also provide relevant test data as necessary. These instructions will be used for QA testing below.
Please describe how to test and/or verify your changes. Provide instructions so we can reproduce. Please also provide relevant test data as necessary. These instructions will be used for QA testing below.

- [ ] Test A
- [ ] Test B
Expand Down
27 changes: 23 additions & 4 deletions .github/workflows/pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,15 @@ jobs:
run: |
npm ci
docker-compose build app
- name: Get installed Playwright version
-
name: Get installed Playwright version
id: playwright-version
# https://github.com/microsoft/playwright/issues/7249#issuecomment-1201476980
run: echo -n "::set-output name=version::$(npm ls @playwright/test --json | jq --raw-output '.dependencies["@playwright/test"].version')"

# https://github.com/microsoft/playwright/issues/7249#issuecomment-1154603556
- name: Cache playwright browsers
-
name: Cache playwright browsers
uses: actions/cache@v3
id: playwright-cache
with:
Expand All @@ -63,18 +65,35 @@ jobs:
# https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy
key: 'playwright-${{ steps.playwright-version.outputs.version }}'

- name: Playwright E2E Tests
-
name: Playwright E2E Tests
working-directory: .
# see https://playwright.dev/docs/ci#github-actions
run: npm run make playwright-tests

- name: Upload test results
-
name: Upload test results
if: always()
uses: actions/upload-artifact@v2
with:
name: test-results
path: test-results

check-code-formatting:
runs-on: ubuntu-latest
steps:
-
uses: actions/checkout@v2
-
uses: actions/setup-node@v2
with:
node-version: "16.14.0"
cache: "npm"
-
name: Run prettier check
working-directory: .
run: npx prettier --check .

# protractor-tests:
# runs-on: ubuntu-latest

Expand Down
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx lint-staged
4 changes: 1 addition & 3 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@
"sourceMapPathOverrides": {
"webpack:///./*": "${workspaceFolder}/src/angular-app/*"
},
"runtimeArgs": [
"--remote-debugging-port=9222"
]
"runtimeArgs": ["--remote-debugging-port=9222"]
}
]
}
5 changes: 1 addition & 4 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
{
"phpunit.args": [
"--configuration",
"test/php/phpunit.xml"
],
"phpunit.args": ["--configuration", "test/php/phpunit.xml"],
"phpcs.composerJsonPath": "src",
"php.suggest.basic": false,
"git.ignoreLimitWarning": true,
Expand Down
121 changes: 59 additions & 62 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -1,67 +1,64 @@
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
"label": "webpack",
"type": "shell",
"windows": {
"command": "bash -c 'npm run webpack'"
},
"linux": {
"command": "npm run webpack"
},
"problemMatcher": "$awesometsc",
"group": {
"kind": "build",
"isDefault": true
},
"presentation": {
"reveal": "silent"
}
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
"label": "webpack",
"type": "shell",
"windows": {
"command": "bash -c 'npm run webpack'"
},
{
"label": "webpack-watch",
"type": "shell",
"isBackground": true,
"windows": {
"command": "bash -c 'npm run webpack:watch'"
},
"linux": {
"command": "npm run webpack:watch"
},
"presentation": {
"reveal": "silent"
},
"problemMatcher": []
"linux": {
"command": "npm run webpack"
},
{
"label": "npm install",
"type": "shell",
"windows": {
"command": "bash -c 'npm install'"
},
"linux": {
"command": "npm install"
},
"presentation": {
"reveal": "silent"
},
"problemMatcher": []
"problemMatcher": "$awesometsc",
"group": {
"kind": "build",
"isDefault": true
},
{
"label": "Reset E2E tests",
"type": "process",
"command": "docker-compose",
"args": [
"restart",
"app-for-e2e"
],
"options": {
"cwd": "docker"
},
"problemMatcher": []
"presentation": {
"reveal": "silent"
}
]
}
},
{
"label": "webpack-watch",
"type": "shell",
"isBackground": true,
"windows": {
"command": "bash -c 'npm run webpack:watch'"
},
"linux": {
"command": "npm run webpack:watch"
},
"presentation": {
"reveal": "silent"
},
"problemMatcher": []
},
{
"label": "npm install",
"type": "shell",
"windows": {
"command": "bash -c 'npm install'"
},
"linux": {
"command": "npm install"
},
"presentation": {
"reveal": "silent"
},
"problemMatcher": []
},
{
"label": "Reset E2E tests",
"type": "process",
"command": "docker-compose",
"args": ["restart", "app-for-e2e"],
"options": {
"cwd": "docker"
},
"problemMatcher": []
}
]
}
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
## Ways to Contribute

## Ways to Contribute ##
1. Look for issues in our issue tracker marked with *good first issue*
1. Look for issues in our issue tracker marked with _good first issue_
2. If you are a Language Forge user, stay up to date with posts in our software community forum, and answer user's questions to the extent that you are able
3. Help localize the Language Forge UI into a language that you are familiar with

## Contributing Code

### Typical Workflow

## Contributing Code ##
### Typical Workflow ###
1. Create a branch off of `develop`
1. Create a PR back into `develop`
1. Once approved and merged, test those changes on [qa.languageforge.org](https://qa.languageforge.org)
1. Once you are satisfied with the changes, coordinate with the team to deliver those changes to the production environment
1. Team leads will determine when the right time to cut a release, i.e., tag and deploy, typically this should be within a day or two

### Production Bugfix Workflow ###
### Production Bugfix Workflow

1. There may be times when it's necessary to create a branch off of `master` (e.g. a hotfix for the production environment)
1. Coordinate with the team to deliver those changes to the production environment
1. Team leads will determine when the right time to cut a release, i.e., tag and deploy, this would likely be right away under these exceptional circumstances
Loading

0 comments on commit 77a6321

Please sign in to comment.