development/github-desktop
development/github-desktop
1
0
Fork 0
mirror of https://github.com/desktop/desktop synced 2024-09-19 16:12:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

first pass at docs about linux testing

Browse source
This commit is contained in:
Brendan Forster 2017-12-14 16:24:47 +10:30
parent 4f17723506
commit 43393e31e7
1 changed files with 67 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

67
docs/contributing/linux-testing-and-you.md Normal file
View file

@ -0,0 +1,67 @@
# Linux Testing and You
GitHub Desktop doesn't currently support Linux in an official capacity, but many in the community have already been experimenting and testing it on on their preferred distributions.
This document outlines the process to help provide a set of quality installers, based on community feedback and contributions.
## Goals
The goals for this testing process are:
* test installers and Desktop on a variety of distributions
* report issues and provide feedback - either about running Desktop or the installer
* triage and address feedback whenever contributors have bandwidth
## Testing Release Candidates
Release Candidate installers can be found on [**@shiftkey**](https://github.com/shiftkey)'s [fork](https://github.com/shiftkey/desktop), listed under the [Releases](https://github.com/shiftkey/desktop/releases) tab.
The current installer formats supported are Debian, RPM and AppImage.
We aim to make new installers available soon after the main Desktop project tags and publishes a new update. To receive notifications when these updates are published, [subscribe](https://github.com/shiftkey/desktop/subscription) to [**@shiftkey's**](https://github.com/shiftkey) fork of the repository.
Subscribing to notifications also helps the core team to identify how many people are actively interested in this testing process.
## Providing Feedback
If you find an issue with running the installer or Desktop on your platform, please open an issue on [`shiftkey/desktop`](https://github.com/shiftkey/desktop). **Do not open issues against the main repository - these issues will be closed with a note to report the issue to the right repository.**
The issue template asks for details about your setup and how to reproduce the issue - please fill this out, as it will help with understanding and reproducing the issue.
Feel free to submit other questions or suggestions to [`shiftkey/desktop`](https://github.com/shiftkey/desktop) - this will give us a place to discuss things in more detail than the original thread about Linux support.
## Contributing Fixes
If you are interested in testing installers locally, first ensure your [development environment is setup](https://github.com/desktop/desktop/blob/master/docs/contributing/setup.md) to build and test Desktop.
Once your environment is setup, you can create an installer locally by running:
```shellsession
$ yarn
$ yarn build:prod
$ yarn run package
```
If you think you've found a solution, please submit a pull request to [`shiftkey/desktop`](https://github.com/shiftkey/desktop) explaining the change and what it fixes. If you're not quite sure, open an issue on the [`shiftkey/desktop`](https://github.com/shiftkey/desktop) fork explaining what you've found and where you think the problem lies. Maybe someone else has insight into the issue.
[**@shiftkey**](https://github.com/shiftkey) will co-ordinate upstreaming merged pull requests to the main repository.
## Technical Details
We use `electron-packager` to generate the artifacts and `electron-builder` to generate the installer.
`electron-packager` details:
* [API options](https://github.com/electron-userland/electron-packager/blob/master/docs/api.md#options)
* [`dist-info.js` config file](https://github.com/desktop/desktop/blob/master/script/dist-info.js)
* [Usage in Desktop](https://github.com/desktop/desktop/blob/master/script/build.ts#L98-L151)
`dist-info.js` contains the various metadata we provide to Desktop as part of packaging. This seems fairly stable, but we might need to tweak some things in here for Linux-specific changes.
`electron-builder` details:
* [API options](https://www.electron.build/configuration/linux)
* [`electron-builder-linux.yml` config file](https://github.com/desktop/desktop/blob/master/script/electron-builder-linux.yml)
* [Usage in Desktop](https://github.com/desktop/desktop/blob/master/script/package.ts#L124-L145)
We use `electron-builder-linux.yml` to configure the installers, so please investigate the documentation to see if something has been overlooked and can be enabled fairly easily.