mirror of
https://gitlab.com/fdroid/fdroidserver.git
synced 2024-11-11 01:40:11 +01:00
Merge branch 'doc-updates' into 'master'
doc updates See merge request fdroid/fdroidserver!1518
This commit is contained in:
commit
1f82e10748
@ -44,7 +44,8 @@ guidelines:
|
||||
formatted as _black_. Some files are not yet fully in _black_ format (see
|
||||
_pyproject.toml_), our goal is to opportunistically convert the code whenever
|
||||
possible. As of the time of this writing, forcing the code format on all files
|
||||
would be too disruptive.
|
||||
would be too disruptive. The officially supported _black_ version is the one
|
||||
in Debian/stable.
|
||||
|
||||
* Many of the tests run very fast and can be run interactively in isolation.
|
||||
Some of the essential test cases run slowly because they do things like
|
||||
|
21
README.md
21
README.md
@ -34,6 +34,19 @@ package managers. All of the options are documented on the website:
|
||||
https://f-droid.org/docs/Installing_the_Server_and_Repo_Tools
|
||||
|
||||
|
||||
## Releases
|
||||
|
||||
The production setup of _fdroidserver_ for f-droid.org is run directly from the
|
||||
_master_ branch. This is put into production on an schedule (currently weekly).
|
||||
So development and testing happens in the branches. We track branches using
|
||||
merge requests. Therefore, there are many WIP and long-lived merge requests.
|
||||
|
||||
There are also stable releases of _fdroidserver_. This is mostly intended for
|
||||
running custom repositories, where the build process is separate. It can also
|
||||
be useful as a simple way to get started contributing packages to _fdroiddata_,
|
||||
since the stable releases are available in package managers.
|
||||
|
||||
|
||||
## Tests
|
||||
|
||||
To run the full test suite:
|
||||
@ -75,14 +88,6 @@ locally](https://docs.gitlab.com/runner/commands/README.html#gitlab-runner-exec)
|
||||
like this: `gitlab-runner exec docker ubuntu_lts`
|
||||
|
||||
|
||||
### Buildserver
|
||||
|
||||
The tests for the whole build server setup are entirely separate
|
||||
because they require at least 200 GB of disk space, and 8 GB of
|
||||
RAM. These test scripts are in the root of the project, all starting
|
||||
with _jenkins-_ since they used to be run on https://jenkins.debian.net.
|
||||
|
||||
|
||||
## Documentation
|
||||
|
||||
The API documentation based on the docstrings gets automatically
|
||||
|
Loading…
Reference in New Issue
Block a user