Skip to content

Commit 1b29b7c

Browse files
committed
reword
1 parent 38727d2 commit 1b29b7c

File tree

3 files changed

+20
-19
lines changed

3 files changed

+20
-19
lines changed

index.html.jinja2

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{% extends "frame.html.jinja2" %}
22
{% block head %}
3-
<title>autofix.ci</title>
3+
<title>autofix.ci: automatically fix pull requests</title>
44
{% endblock %}
55
{% block body %}
66
<style>/* pygments */{{ pygments_css }}</style>
@@ -141,16 +141,16 @@
141141
<h3 id="which-platforms-are-supported" class="fs-5">Which platforms are supported?</h3>
142142
<ul>
143143
<li>
144-
<strong>autofix.ci</strong> currently supports GitHub and GitHub Actions only.
144+
<strong>autofix.ci</strong> supports GitHub Actions only.
145145
</li>
146146
</ul>
147147

148148
<h3 id="does-it-work-for-all-commits" class="fs-5">Does it work for all commits?</h3>
149149
<ul>
150150
<li>
151-
For safety reasons, <strong>autofix.ci</strong> will not push for commits made by bots. This
152-
avoids
153-
infinite loops with bots continuously correcting each other.
151+
For safety reasons, <strong>autofix.ci</strong> will not apply patches if the last commit has
152+
been authored by a bot.
153+
This avoids infinite loops with bots continuously correcting each other.
154154
</li>
155155
</ul>
156156

@@ -172,10 +172,10 @@
172172
<h3 id="is-it-secure" class="fs-5">Is it secure?</h3>
173173
<ul>
174174
<li>
175-
Yes, because we keep the necessary GitHub authentication token away from potentially untrusted
176-
actions. By using autofix.ci, you only provide your autofix.ci workflow with the capability to
177-
update the pull request branch once. Please see <a href="/security">autofix.ci/security</a>
178-
for details.
175+
Yes, because we keep <strong>autofix.ci</strong>'s GitHub authentication token away from potentially untrusted
176+
actions. By using <strong>autofix.ci</strong>, you only provide your auto-fixing workflow with
177+
the capability to update the pull request branch once.
178+
Please see <a href="/security">autofix.ci/security</a> for details.
179179
</li>
180180
</ul>
181181

security.html.jinja2

+4-4
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,6 @@
2020
completely untrusted and potentially compromised. The autofix.ci API only enables the workflow
2121
to update the current pull request once.
2222
</li>
23-
<li>
24-
autofix.ci's hosted service is written in a memory-safe language that emphasizes correctness
25-
(Rust).
26-
</li>
2723
<li>
2824
autofix.ci minimizes untrusted input and data processing where possible. For example,
2925
instead of using <samp>git checkout/apply/push</samp>, we have decided to use
@@ -34,6 +30,10 @@
3430
instead of applying git commands on untrusted repositories (see e.g.
3531
<a href="https://access.redhat.com/security/cve/cve-2021-21300">CVE-2021-21300</a>).
3632
</li>
33+
<li>
34+
autofix.ci's hosted service is written in a memory-safe language that emphasizes correctness
35+
(Rust).
36+
</li>
3737
<li>
3838
autofix.ci's main author has extensive practical (building security software, organizing and
3939
playing CTF security competitions) and theoretical security experience (CS PhD

setup.html.jinja2

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{% extends "frame.html.jinja2" %}
22
{% block head %}
3-
<title>autofix.ci: setup</title>
3+
<title>Setup autofix.ci</title>
44
{% endblock %}
55
{% macro examplebox(filename) %}
66
<div class="card mb-3">
@@ -73,8 +73,9 @@
7373
<h2 id="python">Python</h2>
7474
<p>
7575
This example demonstrates the use of some of the most popular Python code fixing tools.
76-
We use the <a href="https://github.com/install-pinned/">@install-pinned</a> actions to keep things
77-
simple,
76+
We use the <a href="https://github.com/install-pinned/">@install-pinned</a> actions to securely
77+
install hardcoded versions of all tools, but you can also use an existing
78+
<code>requirements.txt</code> file, for example.
7879
</p>
7980
{{ examplebox("python.yml") }}
8081
<p>
@@ -128,9 +129,9 @@
128129

129130
<h2 id="pre-commit">pre-commit hooks</h2>
130131
<p>
131-
If your workflow is based on pre-commit hooks only,
132-
<a href="https://pre-commit.ci/">pre-commit.ci</a>
133-
offers a strong alternative to autofix.ci. Of course, you can also use pre-commit hooks in your
132+
If your existing workflow is based on pre-commit.com hooks, you should use
133+
<a href="https://pre-commit.ci/">pre-commit.ci</a> instead of autofix.ci.
134+
Of course, you can also integrate pre-commit hooks in your
134135
autofix.ci workflow:
135136
</p>
136137
{{ examplebox("pre-commit.yml") }}

0 commit comments

Comments
 (0)