keymanapp / developer.keyman.com Goto Github PK

• Get all repos
• Get projects

Trying to call an API method that requires authentication without an authentication token should result in 401. However, the different methods return different values (which are different from what's documented).

Check how we deal with the following scenarios:

• PR gets merged; user makes additional changes to single-keyboard repo (skr), creates a new PR
• user creates a PR; abandons PR, makes additional changes in skr, and creates a new PR
• user creates a PR; abandons PR, resets skr, does force-push on skr, and creates a new PR
• PR gets merged; some changes get made directly in keyboards repo; user makes changes in skr, creates a new PR

(a PR here means getting the changes from the single-keyboard repo into keyboards repo)

The first step when creating a pull request/project should be to fetch keymanapp/keyboards before fetching the user's keyboards repo and transferring the changes from his single keyboard repo to his keyboards repo.

This is necessary because the user most likely won't keep his keyboards repo up-to-date and will help to make merge conflicts less likely.

• Displays while the server clones the project and creates or updates the pull request
• Status message is different based on the context

src/pull-request/pull-request.service.ts hard-codes the names of the special prefixes. This could be retrieved dynamically from the folder names of the keyboards repo - every folder under releases with name.length > 1 is a special folder.

• Clone project from GitHub
• Pull project from GitHub
• Push project to GitHub
• Extract keyboard id
• Determine location in file system
• Create branch

When a user logs in that hasn't created any github accounts yet, we should display a message that there are no repos.

The frontend tests always pass on my Linux machine. On my Windows machine they don't run at all.

• Login
• Get access token
• Logout
• User information

When creating a project the backend should check if the given repo is a single-keyboard repo and otherwise return an error.

• Displays information about creating a project

Write e2e tests for:

• Create a PR from commits on single keyboards repo (skr) (201)
• Update a PR from new commits on skr (201)
• Can not update an existing PR if there are no new commits on skr (304)
• Can not update an existing PR if skr got force-pushed (400)
• Can not update an existing PR if keyboards repo got new changes in skr-branch (409)

This tests the functionality implement in #56 and #57.

• Displays error message

• Displayed after a pull request got created or updated
• Lets the user return to the projects selection page

• Extract patch from repo
• Apply patch to repo
• Create pull request
• Save state in git notes
• Extract state from git notes

• Lets the user edit the keyboard id
• Let the user select/edit the prefix
• Triggers the creation of a pull request

Will most likely run on Azure.

Docker, nginx?

• Login

• Logout

• Detect if user is logged in

• Display username and avatar

• User service as client-side endpoint of REST API

• List user’s GitHub repos
• Allows to select one project
• Link to help page
• Project service as client-side endpoint of REST API

Client and server side projects in one git repo

When using OAUTH token it's not possible to use git push command to push commits on behalf of the user.

However, GitHub provides a Database API that allows low-level access to git objects. Using this API it's possible to implement pushing of commits by re-creating commits on GitHub.

The grid layout with small boxes for repo names are a little awkward. May be better to use a list layout for this.