Skip to content

Commit 66b4109

Browse files
humitoshumitos
committed
Merge tag '7.6.0' into rel
2 parents 4d3f02d + cf2034f commit 66b4109

40 files changed

+756
-446
lines changed

‎.github/workflows/main.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ jobs:
1515
run: |
1616
curl --request POST \
1717
--silent --output /dev/null \
18-
--url https://circleci.com/api/v1.1/project/github/${{ secrets.CORPORATE_REPO }}/tree/main \
18+
--url https://circleci.com/api/v2/project/gh/${{ secrets.CORPORATE_REPO }}/pipeline \
1919
--user '${{ secrets.CIRCLECI_USER_TOKEN }}:' \
20-
--data 'build_parameters[CIRCLE_JOB]=${{ secrets.CIRCLECI_JOB }}'
20+
--header 'content-type: application/json' \
21+
--data '{"branch": "main", "parameters":{"CIRCLE_JOB": "${{ secrets.CIRCLECI_JOB }}"}}'

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
.cache
99
.coverage
1010
.coverage.*
11+
coverage.xml
1112
.idea
1213
.vagrant
1314
.vscode

‎CHANGELOG.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
1+
Version 7.6.0
2+
-------------
3+
4+
:Date: April 12, 2022
5+
6+
* `@stsewd <https://github.com/stsewd>`__: Celery: workaround fix for bug on retrying builds (`#9096 <https://github.com/readthedocs/readthedocs.org/pull/9096>`__)
7+
* `@stsewd <https://github.com/stsewd>`__: CI: use circle api v2 to trigger builds (`#9094 <https://github.com/readthedocs/readthedocs.org/pull/9094>`__)
8+
* `@ericholscher <https://github.com/ericholscher>`__: Try to fix .com tests (`#9092 <https://github.com/readthedocs/readthedocs.org/pull/9092>`__)
9+
* `@humitos <https://github.com/humitos>`__: Notification: don't send it on build retry (`#9086 <https://github.com/readthedocs/readthedocs.org/pull/9086>`__)
10+
* `@stsewd <https://github.com/stsewd>`__: Docs: add notes about gvisor on Fedora (`#9085 <https://github.com/readthedocs/readthedocs.org/pull/9085>`__)
11+
* `@stsewd <https://github.com/stsewd>`__: Update common (`#9084 <https://github.com/readthedocs/readthedocs.org/pull/9084>`__)
12+
* `@humitos <https://github.com/humitos>`__: Build: bugfix `RepositoryError.CLONE_ERROR` message (`#9083 <https://github.com/readthedocs/readthedocs.org/pull/9083>`__)
13+
* `@stsewd <https://github.com/stsewd>`__: Redirects: remove unused code (`#9080 <https://github.com/readthedocs/readthedocs.org/pull/9080>`__)
14+
* `@stsewd <https://github.com/stsewd>`__: Proxito: only check for index files if there is a version (`#9079 <https://github.com/readthedocs/readthedocs.org/pull/9079>`__)
15+
* `@stsewd <https://github.com/stsewd>`__: Adapt scripts and docs to make use of the new github personal tokens (`#9078 <https://github.com/readthedocs/readthedocs.org/pull/9078>`__)
16+
* `@stsewd <https://github.com/stsewd>`__: Redirects: avoid using re.sub (`#9077 <https://github.com/readthedocs/readthedocs.org/pull/9077>`__)
17+
* `@stsewd <https://github.com/stsewd>`__: Proxito: fix URL parsing (`#9075 <https://github.com/readthedocs/readthedocs.org/pull/9075>`__)
18+
* `@ericholscher <https://github.com/ericholscher>`__: Release 7.5.1 (`#9074 <https://github.com/readthedocs/readthedocs.org/pull/9074>`__)
19+
* `@pyup-bot <https://github.com/pyup-bot>`__: pyup: Scheduled weekly dependency update for week 14 (`#9073 <https://github.com/readthedocs/readthedocs.org/pull/9073>`__)
20+
* `@humitos <https://github.com/humitos>`__: Github: use probot auto-assign bot (`#9069 <https://github.com/readthedocs/readthedocs.org/pull/9069>`__)
21+
* `@agjohnson <https://github.com/agjohnson>`__: Add gVisor runtime option for build containers (`#9066 <https://github.com/readthedocs/readthedocs.org/pull/9066>`__)
22+
* `@humitos <https://github.com/humitos>`__: Docs: `build.jobs` reference documentation (`#9056 <https://github.com/readthedocs/readthedocs.org/pull/9056>`__)
23+
* `@humitos <https://github.com/humitos>`__: Proxito: do not serve non-existent versions (`#9048 <https://github.com/readthedocs/readthedocs.org/pull/9048>`__)
24+
* `@stsewd <https://github.com/stsewd>`__: Traffic analytics: track 404s (`#9027 <https://github.com/readthedocs/readthedocs.org/pull/9027>`__)
25+
* `@humitos <https://github.com/humitos>`__: SyncRepositoryTask: rate limit to 1 per minute per project (`#9021 <https://github.com/readthedocs/readthedocs.org/pull/9021>`__)
26+
* `@stsewd <https://github.com/stsewd>`__: Sync versions: filter by type on update (`#9019 <https://github.com/readthedocs/readthedocs.org/pull/9019>`__)
27+
* `@humitos <https://github.com/humitos>`__: Build: implement `build.jobs` config file key (`#9016 <https://github.com/readthedocs/readthedocs.org/pull/9016>`__)
28+
129
Version 7.5.1
230
-------------
331

‎common

‎docker-compose.override.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ services:
2424
server:
2525
build:
2626
args:
27+
GITHUB_USER: ${GITHUB_USER:-}
2728
GITHUB_TOKEN: ${GITHUB_TOKEN:-}
2829

2930
cache:

‎dockerfiles/Dockerfile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
FROM ubuntu:20.04
22

3+
ARG GITHUB_USER
34
ARG GITHUB_TOKEN
45

56
ENV DEBIAN_FRONTEND noninteractive
@@ -58,9 +59,9 @@ RUN pip3 install --no-cache-dir -r docker.txt
5859
WORKDIR /usr/src/app/checkouts/
5960
RUN if [ -n "$GITHUB_TOKEN" ] ; \
6061
then \
61-
git clone --depth 1 https://${GITHUB_TOKEN}@github.com/readthedocs/readthedocs-ext ; \
62+
git clone --depth 1 https://${GITHUB_USER}:${GITHUB_TOKEN}@github.com/readthedocs/readthedocs-ext ; \
6263
pip3 install --no-cache-dir -e readthedocs-ext ; \
63-
git clone --depth 1 https://${GITHUB_TOKEN}@github.com/readthedocs/ext-theme ; \
64+
git clone --depth 1 https://${GITHUB_USER}:${GITHUB_TOKEN}@github.com/readthedocs/ext-theme ; \
6465
pip3 install --no-cache-dir -e ext-theme ; \
6566
fi
6667

‎docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767

6868
master_doc = "index"
6969
copyright = "2010, Read the Docs, Inc & contributors"
70-
version = "7.5.1"
70+
version = "7.6.0"
7171
release = version
7272
exclude_patterns = ["_build"]
7373
default_role = "obj"

‎docs/dev/guides/gvisor.rst

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
gVisor Installation
2+
===================
3+
4+
You can mostly get by just following installation instructions in the `gVisor
5+
Docker Quick Start`_ guide.
6+
7+
There are a few caveats to installation, which likely depend on your local
8+
environment. For ``systemd`` based OS, you do need to configure the Docker
9+
daemon to avoid systemd cgroups.
10+
11+
.. tabs::
12+
13+
.. tab:: Arch
14+
15+
Follow the installation and quick start directions like normal:
16+
17+
.. code:: console
18+
19+
% yay -S gvisor-bin
20+
...
21+
% sudo runsc install
22+
23+
You do need to instruct Docker to avoid systemd cgroups. You will need
24+
to make further changes to ``/etc/docker/daemon.json`` and restart the
25+
Docker service:
26+
27+
.. code:: json
28+
29+
{
30+
"runtimes": {
31+
"runsc": {
32+
"path": "/usr/bin/runsc"
33+
}
34+
},
35+
"exec-opts": ["native.cgroupdriver=cgroupfs"]
36+
}
37+
38+
.. tab:: Fedora
39+
40+
- Install docker from their repositories,
41+
the one included in Fedora doesn't work,
42+
using their `convenience script`_ is an easy way to do it.
43+
- `Install gvisor manually`_, the one included in Fedora doesn't work.
44+
- Enable cgroups v1:
45+
46+
.. code:: console
47+
48+
% sudo grubby --update-kernel=ALL --args="systemd.unified_cgroup_hierarchy=0"
49+
50+
.. _convenience script: https://docs.docker.com/engine/install/fedora/#install-using-the-convenience-script
51+
.. _Install gvisor manually: https://gvisor.dev/docs/user_guide/install/#install-latest
52+
53+
Docker is correctly configured when you can run this command from the quick
54+
start guide:
55+
56+
.. code:: console
57+
58+
% docker run --rm -ti --runtime=runsc readthedocs/build dmesg
59+
[ 0.000000] Starting gVisor...
60+
...
61+
62+
.. _gVisor Docker Quick Start: https://gvisor.dev/docs/user_guide/quick_start/docker/
63+
64+
Testing gVisor
65+
--------------
66+
67+
You can enable the gVisor feature flag on a project and you should see the
68+
container created with ``runtime=runsc`` now.

‎docs/dev/guides/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Development Guides
2+
==================
3+
4+
These are guides to aid local development and common development procedures.
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
:glob:
9+
10+
*

‎docs/dev/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ or taking the open source Read the Docs codebase for your own custom installatio
1919
:maxdepth: 1
2020

2121
install
22+
guides/index
2223
design
2324
docs
2425
front-end

‎docs/dev/install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Set up your environment
4747

4848
.. tip::
4949

50-
If you pass ``GITHUB_TOKEN`` environment variable to this command,
50+
If you pass the ``GITHUB_TOKEN`` and ``GITHUB_USER`` environment variables to this command,
5151
it will add support for readthedocs-ext.
5252

5353
#. pull down Docker images for the builders:

‎docs/user/guides/private-python-packages.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ URI example:
5656

5757
.. code::
5858
59-
git+https://${GITHUB_TOKEN}@github.com/user/project.git@{version}
59+
git+https://${GITHUB_USER}:${GITHUB_TOKEN}@github.com/user/project.git@{version}
6060
6161
.. warning::
6262

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "readthedocs",
3-
"version": "7.5.1",
3+
"version": "7.6.0",
44
"description": "Read the Docs build dependencies",
55
"author": "Read the Docs, Inc <[email protected]>",
66
"scripts": {

‎readthedocs/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
"""Read the Docs."""
22

33

4-
__version__ = "7.5.1"
4+
__version__ = "7.6.0"

‎readthedocs/analytics/migrations/0002_track_status_code.py

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Generated by Django 3.2.12 on 2022-03-29 17:51
2+
3+
import django.db.models.deletion
4+
from django.db import migrations, models
5+
6+
7+
class Migration(migrations.Migration):
8+
9+
dependencies = [
10+
("builds", "0041_track_task_id"),
11+
("projects", "0087_use_booleanfield_null"),
12+
("analytics", "0001_initial"),
13+
]
14+
15+
operations = [
16+
migrations.AddField(
17+
model_name="pageview",
18+
name="full_path",
19+
field=models.CharField(
20+
blank=True,
21+
help_text="Full path including the version and language parts.",
22+
max_length=4096,
23+
null=True,
24+
),
25+
),
26+
migrations.AddField(
27+
model_name="pageview",
28+
name="status",
29+
field=models.PositiveIntegerField(
30+
default=200, help_text="HTTP status code"
31+
),
32+
),
33+
migrations.AlterField(
34+
model_name="pageview",
35+
name="path",
36+
field=models.CharField(
37+
help_text="Path relative to the version.", max_length=4096
38+
),
39+
),
40+
migrations.AlterField(
41+
model_name="pageview",
42+
name="version",
43+
field=models.ForeignKey(
44+
null=True,
45+
on_delete=django.db.models.deletion.CASCADE,
46+
related_name="page_views",
47+
to="builds.version",
48+
verbose_name="Version",
49+
),
50+
),
51+
migrations.AlterUniqueTogether(
52+
name="pageview",
53+
unique_together={("project", "version", "path", "date", "status")},
54+
),
55+
]

0 commit comments

Comments
 (0)