diff --git a/README.md b/README.md index 414159a..de2212c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/pre-commit-ci/pre-commit.ci/main.svg)](https://results.pre-commit.ci/latest/github/pre-commit-ci/pre-commit.ci/main) +[![Build Status](https://github.com/pre-commit-ci/pre-commit.ci/actions/workflows/deploy.yml/badge.svg)](https://github.com/pre-commit-ci/pre-commit.ci/actions) + pre-commit.ci ============= diff --git a/cookie_notice.html b/cookie_notice.html new file mode 100644 index 0000000..60d8b5a --- /dev/null +++ b/cookie_notice.html @@ -0,0 +1,137 @@ + + + + + + pre-commit.ci - cookie notice + + + + + + + +
+
+ +
+
+ +
+

Cookie Notice


This Cookie Notice applies to your use of pre-commit.ci, any related websites, +applications, or services owned and operated by pre-commit ci, LLC +("pre-commit.ci", "we", "us", "our"). We use certain +technologies to collect information through pre-commit.ci Services. In this +Cookie Notice, we refer to these technologies, which include HTTP cookies, +local storage, pixel tags and, web beacons, collectively as “cookies.” This +notice explains the different types of cookies used to provide our Services +and how you can control them. We may change this Cookie Notice at any time.

+

When you visit our website https://pre-commit.ci (the +"Website"), and more generally, use any of our services (the +"Services", which include the Website), you are accepting the information +handling practices and storage and access of cookies as described in this +Cookie Notice.

+

We hope that this notice helps you understand, and feel more confident about, +our use of cookies. If you have any further queries, please contact us at +privacy@pre-commit.ci.

+

What is a Cookie?

+

Cookies are small text files that are stored on your device. They are widely +used in order to make websites and software applications work, or work in a +better, more efficient way. They can do this because websites and software +applications can read and write these files, enabling them to recognize a +particular device and remember important information that will make your use +of a website or software application more convenient.

+

What Cookies do we use and why do we use them?

+

Below we list the different types of cookies we may use to provide our +Services.

+ +

Below lists our Cookie IDs and Purposes:

+

session

+

Authentication & authorization

+

How do I control Cookies?

+

You may also refuse to accept cookies from our Services at any time by activatin + the setting on your browser which allows you to refuse cookies. Further +information about the procedure to follow in order to disable cookies can be +found on your Internet browser provider’s website via your help screen. For +additional guidance please visit the +Digital Advertising Alliance’s Ad Choices page. Please be aware that if +cookies are disabled, not all features of our Services may operate as intended.

+ +
+ + + + + diff --git a/css/main.css b/css/main.css deleted file mode 100644 index 7069651..0000000 --- a/css/main.css +++ /dev/null @@ -1,12 +0,0 @@ -.pc-top-shelf a { - color: #f8f9fa; - text-decoration: underline; -} -.pc-top-shelf a:hover { - text-decoration: none; -} - -.pc-logo { - width: 5rem; - height: 5rem; -} diff --git a/img/autofix.png b/img/autofix.png new file mode 100644 index 0000000..e17ac85 Binary files /dev/null and b/img/autofix.png differ diff --git a/img/autoupdate.png b/img/autoupdate.png new file mode 100644 index 0000000..f6e9bfe Binary files /dev/null and b/img/autoupdate.png differ diff --git a/img/build.png b/img/build.png new file mode 100644 index 0000000..b0af7ca Binary files /dev/null and b/img/build.png differ diff --git a/img/github.svg b/img/github.svg new file mode 100644 index 0000000..70829b6 --- /dev/null +++ b/img/github.svg @@ -0,0 +1 @@ + diff --git a/img/lite.png b/img/lite.png new file mode 100755 index 0000000..3095f5f Binary files /dev/null and b/img/lite.png differ diff --git a/img/logo.png b/img/logo.png new file mode 100644 index 0000000..0936510 Binary files /dev/null and b/img/logo.png differ diff --git a/index.html b/index.html index 471d049..fb69c18 100644 --- a/index.html +++ b/index.html @@ -2,23 +2,123 @@ - - - - - pre-commit.ci - - + + + + + + + + + @@ -43,36 +143,112 @@

time on more valuable problems. -

coming soon!

-

the planned v1 features include:

- -

- pre-commit ci is currently in development, you can follow the - development directly on - twitch. -

-
-

- - to receive updates about development, subscribe to the - mailing list -- - or reach out directly - if you are interested in early adoption - -

+ + + Sign In With GitHub + + +

features


supported hosting platforms: currently only GitHub +is supported, more to come in the future!

+

configuration: zero configuration setup -- nothing is needed beyond the +.pre-commit-config.yaml file you already have!

+

auto fixing pull requests: if tools make changes to files during a pull +request, pre-commit.ci will automatically fix the pull request.

+

pre-commit.ci will run on all pull request commits, but will not push for +commits made by bots.

+

pre-commit.ci auto fixing a pull request

+

speed: much faster than comparable, free CI systems

+

chart comparing CI speeds

+

caching: tool caching is baked in and shared across all users. this means +that the more users there are of pre-commit.ci, the more likely you will get +faster builds!

+

pre-commit.ci build output

+

automatic updates: pre-commit.ci will periodically autoupdate your +configuration ensuring that your hook versions are kept up to date. this +autoupdate is currently scheduled weekly at approximately 16:00 UTC Monday.

+

here is an example autoupdate pull request.

+

pre-commit.ci auto updating a repository

+

re-running a pull request: you can trigger a re-run on a pull request by +commenting pre-commit.ci run (must appear on a line by itself). +alternatively, one can attach a pre-commit.ci run label to the pull request.

+

skipping push runs: skip a run by putting [skip ci], [ci skip], +[skip pre-commit.ci], or [pre-commit.ci skip] in the commit message.

+

configuration

pre-commit.ci is configured in .pre-commit-config.yaml in the ci: section.

+

note: ci: configuration is entirely optional and will assume the defaults +below.

+

autofix_commit_msg

+

(optional, default: '[pre-commit.ci] auto fixes [...]') +custom commit message for PR autofixes.

+

autofix_prs

+

(optional, default: true) whether to autofix pull requests. when +disabled, comment / label "pre-commit.ci autofix" to a pull request to +manually trigger auto-fixing.

+

autoupdate_branch

+

(optional: default '') branch to send autoupdate PRs to.

+

by default, pre-commit.ci will update the default branch of the +repository.

+

this configuration option and other autoupdate settings will be +read from the .pre-commit-config.yaml in the default branch of +the repository.

+

autoupdate_commit_msg

+

(optional, default: '[pre-commit.ci] pre-commit autoupdate') +custom commit message for autoupdate PRs.

+

autoupdate_schedule

+

(optional, default: 'weekly') control when the autoupdate runs, +possible values: 'weekly', 'monthly', 'quarterly'.

+

skip

+

(optional, default: []) a list of hook ids to skip only in +pre-commit.ci

+

for example:

+
ci:
+    skip: [pylint]
+
+repos:
+-   repo: local
+    hooks:
+    -   id: pylint
+        # ...
+
+

this is equivalent to running SKIP=pylint pre-commit ...

+

submodules

+

(optional, default: false) whether to recursively check out submodules

+

a full config with all the defaults:

+
ci:
+    autofix_commit_msg: |
+        [pre-commit.ci] auto fixes from pre-commit.com hooks
+
+        for more information, see https://pre-commit.ci
+    autofix_prs: true
+    autoupdate_branch: ''
+    autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
+    autoupdate_schedule: weekly
+    skip: []
+    submodules: false
+
+

alternative using github actions


pre-commit.ci also provides a lite version which adds auto +fixing to GitHub actions.

+

pricing


pre-commit.ci will always be free for open source repositories.

+

all paid plans also include pre-commit.ci lite pro at no additional cost.

+

for private and organization repository support see the GitHub Marketplace.

+

for single-tenant or larger installations, contact info@pre-commit.ci.

+

following the development


+

sponsoring


if you'd like to support the development there are two ways to sponsor:

+ + + diff --git a/lite.html b/lite.html new file mode 100644 index 0000000..16807e9 --- /dev/null +++ b/lite.html @@ -0,0 +1,221 @@ + + + + + + pre-commit.ci - lite + + + + + + + +
+
+ +
+
+ +
+
+ pre-commit.ci lite is an add-on for GitHub Actions which + safely auto fixes PRs +
+ +

pre-commit.ci lite fixing a PR

+

setup


    +
  1. install the GitHub Application on the relevant repositories

    +
  2. +
  3. add the GitHub action to your workflow as the last step in your job:

    +
        - uses: pre-commit-ci/lite-action@v1.1.0
    +      if: always()
    +
    +
  4. +
+

note: the step must have either the default name or contain the text +pre-commit-ci-lite. the application uses this to find the right workflow.

+

note: the step must be contained in a job which is either by itself in the +workflow or is the last job to finish in the workflow.

+

differences with full version


pre-commit.ci lite only provides auto fixing of PRs, but allows the +flexibility of using GitHub Actions as a runner.

+

feature

+

full

+

lite

+

auto fixing PRs

+

+

+

periodic automatic hook updates

+

+

speed

+

+

arbitrary setup (language: system, etc.)

+

+

other code modification tools

+

+

example using pre-commit/action


technically pre-commit.ci lite works for any code modification, though it was +built with pre-commit in mind. here is an example workflow:

+
on:
+  pull_request:
+  push:
+    branches: [main, test-me-*]
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: 3.x
+    - uses: pre-commit/action@v3.0.1
+    - uses: pre-commit-ci/lite-action@v1.1.0
+      if: always()
+
+

pre-commit ci will skip pushes made by bots to prevent infinite loops. +to trigger an autofix in that scenario, set up a labeled trigger:

+
--- a/.github/workflows/pre-commit.yml
++++ b/.github/workflows/pre-commit.yml
+@@ -1,13 +1,19 @@
+ on:
+   pull_request:
++    types: [labeled, opened, reopened, synchronize]
+   push:
+     branches: [main, test-me-*]
+
+ jobs:
+   main:
++    if: "github.event.action != 'labeled' || github.event.label.name == 'pre-commit ci run'"
+     runs-on: ubuntu-latest
+     steps:
+     - uses: actions/checkout@v3
++    - run: gh pr edit ${{ github.event.number }} --remove-label 'pre-commit ci run'
++      if: github.event.action == 'labeled' && github.event.label.name == 'pre-commit ci run'
++      env:
++        GH_TOKEN: ${{ github.token }}
+     - uses: actions/setup-python@v4
+       with:
+         python-version: 3.x
+
+

pricing


pre-commit.ci will always be free for open source repositories.

+

for private and organization repository support see the GitHub Marketplace.

+

for single-tenant or larger installations, contact info@pre-commit.ci.

+ +
+ + + + + diff --git a/lite_status.html b/lite_status.html new file mode 100644 index 0000000..0a88c15 --- /dev/null +++ b/lite_status.html @@ -0,0 +1,162 @@ + + + + + + pre-commit.ci - lite status + + + + + + + +
+
+ +
+
+ +

pre-commit.ci lite is currently applying the change...

+

pre-commit.ci lite successfully applied the change to the pull request!

+

pre-commit.ci lite was unable to push due to branch protection rules

+

pre-commit.ci lite was unable to push -- permission was denied -- +perhaps the pr was made from an organization?

+

pre-commit.ci lite was unable to push -- permission was denied -- +perhaps the "Allow edits by maintainers" box was unchecked?

+

GitHub prevented pre-commit.ci lite from pushing to this pr due to +changes to a workflow file (.github/workflows/...)

+

pre-commit.ci lite was unable to push to the branch -- branch missing?

+
+ + + + + + diff --git a/privacy_policy.html b/privacy_policy.html new file mode 100644 index 0000000..bc3353a --- /dev/null +++ b/privacy_policy.html @@ -0,0 +1,443 @@ + + + + + + pre-commit.ci - privacy policy + + + + + + + +
+
+ +
+
+ +
+

Privacy Notice


last updated 2021-02-17

+

This Privacy Notice applies to your use of pre-commit.ci, any related +websites, applications, or services owned and operated by pre-commit ci, LLC +("pre-commit.ci", "we", "us", "our"). We are +committed to protecting your personal information and your right to privacy. +If you have any questions or concerns about this privacy notice, or our +practices with regards to your personal information, please contact us at +privacy@pre-commit.ci.

+

When you visit our website https://pre-commit.ci +(the "Website"), and more generally, use any of our services (the +"Services", which include the Website), we appreciate that you are +trusting us with your personal information. We take your privacy very +seriously. In this Privacy Notice, we seek to make clear how we collect, use +and disclose personal information from and about you. By visiting our website, +or using our services, you are accepting the practices explained in this +Privacy Notice, to the extent permitted by law.

+

This Privacy Notice applies to all information collected through our Services +(which, as described above, includes our Website), as well as, any related +services, sales, marketing, or events.

+

Please read this Privacy Notice carefully as it will help you understand what +we do with the information that we collect.

+

What information do we collect?

Personal information you disclose to us

+

We collect information about you through the means listed below when you +visit our website or utilize pre-commit.ci services. We collect this +information in order to provide these services to you, if you do not provide +us with such information or request to delete it, we may not be able to +continue to offer services to you.

+

The personal information we collect may include the following:

+ +

All personal information that you provide to us must be true, complete and +accurate, and you must notify us of any changes to such personal information.

+

How do we use your information?

We use personal information collected via our Website for the business +purposes described below. We process your personal information for these +purposes in reliance on our legitimate business interests, in order to enter +into or perform a contract with you, with your consent, and/or for compliance +with our legal obligations. We indicate the specific processing grounds we +rely on next to each purpose listed below.

+

We use the information we collect or receive:

+ +

Will your information be shared with anyone?

We may process or share your data that we hold based on the following legal +basis:

+ +

More specifically, we may need to process your data or share your personal +information in the following situations:

+ +

Do we use cookies and other tracking technologies?

We may use cookies and similar tracking technologies (like web beacons and +pixels) to access or store information. Specific information about how we use +such technologies and how you can refuse certain cookies is set out in our +Cookie Notice.

+

How long do we keep your information?

We will only keep your personal information for as long as it is necessary for +the purposes set out in this Privacy Notice, unless a longer retention period +is required or permitted by law (such as tax, accounting or other legal +requirements). No purpose in this notice will require us keeping your personal +information for longer than the period of time in which users have an account +with us.

+

When we have no ongoing legitimate business need to process your personal +information, we will either delete or anonymize such information, or, if this +is not possible (for example, because your personal information has been +stored in backup archives), then we will securely store your personal +information and isolate it from any further processing until deletion is +possible.

+

How do we keep your information safe?

We have implemented appropriate technical and organizational security +measures designed to protect the security of any personal information we +process. However, despite our safeguards and efforts to secure your +information, no electronic transmission over the Internet or information +storage technology can be guaranteed to be 100% secure, so we cannot promise +or guarantee that hackers, cybercriminals, or other unauthorized third +parties will not be able to defeat our security, and improperly collect, +access, steal, or modify your information. Although we will do our best to +protect your personal information, transmission of personal information to +and from our Website is at your own risk. You should only access the Website +within a secure environment.

+

What are your privacy rights?

In some regions (like the European Economic Area), you have certain rights +under applicable data protection laws. These may include the right (i) to +request access and obtain a copy of your personal information, (ii) to +request rectification or erasure; (iii) to restrict the processing of your +personal information; and (iv) if applicable, to data portability. In certain +circumstances, you may also have the right to object to the processing of your +personal information. To make such a request, please use the contact details +provided below. We will consider and act upon any request in accordance with +applicable data protection laws.

+

If we are relying on your consent to process your personal information, you +have the right to withdraw your consent at any time. Please note however that +this will not affect the lawfulness of the processing before its withdrawal, +nor will it affect the processing of your personal information conducted in +reliance on lawful processing grounds other than consent.

+

If you are a resident in the European Economic Area and you believe we are +unlawfully processing your personal information, you also have the right to +complain to your local data protection supervisory authority. You can find +their contact details here: +https://ec.europa.eu/justice/data-protection/bodies/authorities/index_en.htm.

+

If you are a resident in Switzerland, the contact details for the data +protection authorities are available here: +https://www.edoeb.admin.ch/edoeb/en/home.html.

+

If you have questions or comments about your privacy rights, you may email us +at privacy@pre-commit.ci.

+

Account Information

+

If you would at any time like to review or change the information in your +account or terminate your account, you can:

+ +

Upon your request to terminate your account, we will deactivate or delete +your account and information from our active databases. However, we may +retain some information in our files to prevent fraud, troubleshoot problems, +assist with any investigations, enforce our Terms of Use and/or comply with +applicable legal requirements.

+

Cookies and similar technologies: Most Web browsers are set to accept +cookies by default. If you prefer, you can usually choose to set your browser +to remove cookies and to reject cookies. If you choose to remove cookies or +reject cookies, this could affect certain features or services of our Website.

+

Controls for Do-Not-Track features

Most web browsers and some mobile operating systems and mobile applications +include a Do-Not-Track ("DNT") feature or setting you can activate to signal +your privacy preference not to have data about your online browsing activities +monitored and collected. At this stage no uniform technology standard for +recognizing and implementing DNT signals has been finalized. As such, we do +not currently respond to DNT browser signals or any other mechanism that +automatically communicates your choice not to be tracked online. If a standard +for online tracking is adopted that we must follow in the future, we will +inform you about that practice in a revised version of this Privacy Notice.

+

Do California residents have specific privacy rights?

California Civil Code Section 1798.83, also known as the "Shine The Light" +law, permits our users who are California residents to request and obtain +from us, once a year and free of charge, information about categories of +personal information (if any) we disclosed to third parties for direct +marketing purposes and the names and addresses of all third parties with +which we shared personal information in the immediately preceding calendar +year. If you are a California resident and would like to make such a request, +please submit your request in writing to us using the contact information +provided below.

+

If you are under 18 years of age, reside in California, and have a registered +account with the Website, you have the right to request removal of unwanted +data that you publicly post on the Website. To request removal of such data, +please contact us using the contact information provided below, and include +the email address associated with your account and a statement that you +reside in California. We will make sure the data is not publicly displayed on +the Website, but please be aware that the data may not be completely or +comprehensively removed from all our systems (e.g. backups, etc.).

+

CCPA Privacy Notice

+

The California Code of Regulations defines a "resident" as:

+
    +
  1. every individual who is in the State of California for other than a +temporary or transitory purpose and
  2. +
  3. every individual who is domiciled in the State of California who is outside +the State of California for a temporary or transitory purpose
  4. +
+

All other individuals are defined as "non-residents."

+

If this definition of "resident" applies to you, we must adhere to certain +rights and obligations regarding your personal information.

+

What categories of personal information do we collect?

+

We have collected the following categories of personal information in the past +twelve (12) months:

+

Category

+

Examples

+

Collected

+

A. Identifiers

+

Contact details, such as real name, alias, postal address, telephone +or mobile contact number, unique personal identifier, online +identifier, Internet Protocol address, email address and account name

+

YES

+

B. Personal information categories listed in the California Customer +Records statute

+

Name, contact information, education, employment, employment history +and financial information

+

NO

+

C. Protected classification characteristics under California or +federal law

+

Gender and date of birth

+

NO

+

D. Commercial information

+

Transaction information, purchase history, financial details and +payment information

+

NO

+

E. Biometric information

+

Fingerprints and voiceprints

+

NO

+

F. Internet or other similar network activity

+

Browsing history, search history, online behavior, interest data, and +interactions with our and other websites, applications, systems and +advertisements

+

NO

+

G. Geolocation data

+

Device location

+

NO

+

H. Audio, electronic, visual, thermal, olfactory, or similar +information

+

Images and audio, video or call recordings created in connection with +our business activities

+

NO

+

I. Professional or employment-related information

+

Business contact details in order to provide you our services at a +business level, job title as well as work history and professional +qualifications if you apply for a job with us

+

NO

+

J. Education Information

+

Student records and directory information

+

NO

+

K. Inferences drawn from other personal information

+

Inferences drawn from any of the collected personal information listed +above to create a profile or summary about, for example, an +individual’s preferences and characteristics

+

NO

+

We may also collect other personal information outside of these categories instances where you interact with us in-person, online, or by phone or mail +in the context of:

+ +

More information about our data collection and sharing practices can be found +in this Privacy Notice.

+

You may contact us by email at +privacy@pre-commit.ci, or by referring to the +contact details at the bottom of this document.

+

If you are using an authorized agent to exercise your right to opt-out we may +deny a request if the authorized agent does not submit proof that they have +been validly authorized to act on your behalf.

+

Will your information be shared with anyone else?

+

We may disclose your personal information with our service providers pursuant +to a written contract between us and each service provider. Each service +provider is a for-profit entity that processes the information on our behalf.

+

We may use your personal information for our own business purposes, such as +for undertaking internal research for technological development and +demonstration. This is not considered to be "selling" of your personal data.

+

pre-commit ci, LLC has not disclosed or sold any personal +information to third parties for a business or commercial purpose in the +preceding 12 months. pre-commit ci, LLC will not sell personal +information in the future belonging to website visitors, users and other +consumers.

+

Your rights with respect to your personal data

+

Right to request deletion of the data - Request to delete

+

You can ask for the deletion of your personal information. If you ask us to +delete your personal information, we will respect your request and delete your +personal information, subject to certain exceptions provided by law, such as +(but not limited to) the exercise by another consumer of his or her right to +free speech, our compliance requirements resulting from a legal obligation or +any processing that may be required to protect against illegal activities.

+

Right to be informed - Request to know

+

Depending on the circumstances, you have a right to know:

+ +

In accordance with applicable law, we are not obligated to provide or delete +consumer information that is de-identified in response to a consumer request +or to re-identify individual data to verify a consumer request.

+

Right to Non-Discrimination for the Exercise of a Consumer’s Privacy Rights

+

We will not discriminate against you if you exercise your privacy rights.

+

Verification process

+

Upon receiving your request, we will need to verify your identity to determine +you are the same person about whom we have the information in our system. +These verification efforts require us to ask you to provide information so +that we can match it with information you have previously provided us. For +instance, depending on the type of request you submit, we may ask you to +provide certain information so that we can match the information you provide +with the information we already have on file, or we may contact you through a +communication method (e.g. phone or email) that you have previously provided +to us. We may also use other verification methods as the circumstances dictate.

+

We will only use personal information provided in your request to verify your +identity or authority to make the request. To the extent possible, we will +avoid requesting additional information from you for the purposes of +verification. If, however, we cannot verify your identity from the information +already maintained by us, we may request that you provide additional +information for the purposes of verifying your identity, and for security or +fraud-prevention purposes. We will delete such additionally provided +information as soon as we finish verifying you.

+

Other privacy rights

+ +

To exercise these rights, you can contact us by email at +privacy@pre-commit.ci, or by referring to the +contact details at the bottom of this document. If you have a complaint about +how we handle your data, we would like to hear from you.

+

Do we make updates to this policy?

We may update this Privacy Notice from time to time. The updated version will +be indicated by an updated "Revised" date and the updated version will be +effective as soon as it is accessible. If we make material changes to this +Privacy Notice, we may notify you either by prominently posting a notice of +such changes or by directly sending you a notification. We encourage you to +review this Privacy Notice frequently to be informed of how we are protecting +your information.

+

How can you contact us about this policy?

If you have questions or comments about this notice, you may email us at +privacy@pre-commit.ci or by post to:

+
pre-commit ci, LLC
1244 Wooley Road
Oxford, MI 48371
United States

How can you review, update, or delete data that we collect?

Based on the applicable laws of your country, you may have the right to +request access to the personal information we collect from you, change that +information, or delete it in some circumstances. To request to review, update, +or delete your personal information, please visit:

+

https://github.com/settings/apps/authorizations

+

We will respond to your request within 30 days.

+ +
+ + + + +