Skip to content

Commit 29fe5a4

Browse files
committed
chore: sync with microG unofficial installer
Signed-off-by: ale5000 <15793015+ale5000-git@users.noreply.github.com>
1 parent 3a447e8 commit 29fe5a4

File tree

6 files changed

+72
-43
lines changed

6 files changed

+72
-43
lines changed

README.rst

Lines changed: 41 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,77 +13,96 @@ Google sync add-on
1313
:target: https://google-sync-addon.readthedocs.io/en/latest/
1414

1515
.. image:: https://codecov.io/gh/micro5k/google-sync-addon/branch/main/graph/badge.svg
16-
:alt: Coverage
16+
:alt: Code coverage on Codecov
1717
:target: https://codecov.io/gh/micro5k/google-sync-addon
1818

1919
.. image:: https://api.reuse.software/badge/github.com/micro5k/google-sync-addon
20-
:alt: REUSE status
20+
:alt: REUSE compliance status
2121
:target: https://api.reuse.software/info/github.com/micro5k/google-sync-addon
2222

2323

2424
Description
2525
===========
2626
Google sync add-on is a flashable zip created by ale5000 for a simple installation of Google sync adapters on Android from 4.4 to 16 (excluding Android 6.x).
27+
No root wizardry required — just flash and go. ✨
2728

28-
**IMPORTANT:** In addition to the normal installation as a pure flashable zip, there are plans for the future (but not in the short term) to also support the installation as a *Magisk* module.
29-
30-
Although you may find various references to *Magisk* in the code, support is **NOT** yet ready.
31-
32-
This project is available on GitHub_, on GitLab_ as well as on XDA_.
29+
This project is available on GitHub_, on GitLab_, as well as on XDA_.
3330

3431
.. _GitHub: https://github.com/micro5k/google-sync-addon
3532
.. _GitLab: https://gitlab.com/micro5k/google-sync-addon
3633
.. _XDA: https://xdaforums.com/t/3432360/
3734

35+
**IMPORTANT:** In addition to the normal installation as a pure flashable zip, there are plans for the future (but not in the short term) to also support the installation as a *Magisk* module.
36+
37+
Although you may find various references to *Magisk* in the code, support is **NOT** yet ready.
38+
39+
40+
.. _readme-download:
3841

3942
Download
4043
========
44+
Grab the latest stable release or, if you like to live dangerously, the nightly build.
45+
The badges below show the current version and download statistics.
46+
4147
.. image:: https://img.shields.io/github/v/release/micro5k/google-sync-addon.svg?cacheSeconds=3600
42-
:alt: GitHub latest release
43-
:target: `Download`_
48+
:alt: GitHub: latest release version
49+
:target: ./docs/INSTRUCTIONS.rst
4450

45-
`Download instructions <docs/INSTRUCTIONS.rst>`_
51+
`Read before you flash <./docs/INSTRUCTIONS.rst>`_ *(ten minutes of reading beats one hour of re-flashing)*
4652

4753

4854
Code analysis
4955
=============
56+
Yes, the code is actually linted. No, it wasn't always pretty. Yes, it's better now. 🔍
57+
58+
CI pipelines run on every push to keep the build healthy — the code-lint workflow checks style and correctness, while the nightly workflow validates a full automated build.
59+
In addition, SonarQube, Codacy, and CodeFactor provide continuous code quality analysis from multiple angles, because one linter is never enough.
60+
5061
.. image:: https://github.com/micro5k/google-sync-addon/actions/workflows/code-lint.yml/badge.svg
51-
:alt: Code lint workflow
62+
:alt: Code lint: CI status
5263
:target: https://github.com/micro5k/google-sync-addon/actions/workflows/code-lint.yml
5364

65+
.. image:: https://github.com/micro5k/google-sync-addon/actions/workflows/auto-nightly.yml/badge.svg
66+
:alt: Nightly build: CI status
67+
:target: https://github.com/micro5k/google-sync-addon/actions/workflows/auto-nightly.yml
68+
5469
.. image:: https://sonarcloud.io/api/project_badges/measure?project=micro5k_google-sync-addon&metric=reliability_rating
55-
:alt: SonarQube reliability rating
70+
:alt: SonarQube: reliability rating
5671
:target: https://sonarcloud.io/summary/new_code?id=micro5k_google-sync-addon
5772

5873
.. image:: https://app.codacy.com/project/badge/Grade/0a3cd4857c224c59afa38e4cdfeb9486
59-
:alt: Codacy Badge
74+
:alt: Codacy: code quality grade
6075
:target: https://app.codacy.com/gh/micro5k/google-sync-addon/dashboard
6176

6277
.. image:: https://www.codefactor.io/repository/github/micro5k/google-sync-addon/badge
63-
:alt: CodeFactor Badge
78+
:alt: CodeFactor: code quality
6479
:target: https://www.codefactor.io/repository/github/micro5k/google-sync-addon
6580

6681

67-
6882
Contributing
6983
============
70-
If you want to improve the project, please review our `contributing guidelines <docs/CONTRIBUTING.rst>`_.
84+
If you want to improve the project, please review our `contributing guidelines <./docs/CONTRIBUTING.rst>`_.
7185

72-
We are grateful for all our contributors!
86+
We are grateful for all our contributors! 🎉
87+
Seriously — every bug fix, improvement, or creative complaint has made this better.
7388

74-
Please check the `contributors list <docs/CONTRIBUTORS.md>`_ for more details.
89+
Please check the `contributors list <./docs/CONTRIBUTORS.md>`_ for more details.
90+
91+
*(Even fixing a typo counts. Probably. We'll review it very carefully either way.)*
7592

7693

7794
Donations
7895
=========
79-
.. image:: https://img.shields.io/badge/Donate-FFF000?logo=ko-fi&logoSize=auto&logoColor=black&cacheSeconds=21600
96+
.. image:: https://img.shields.io/badge/Donate-FFF000?style=for-the-badge&logo=ko-fi&logoSize=auto&logoColor=black&cacheSeconds=21600
8097
:alt: Support this project
8198
:target: ./docs/DONATE.rst
8299

83-
I maintain this project on my own in my spare time.
84-
If it's been helpful to you, please consider supporting its development!
100+
I maintain this project on my own in my spare time — the finite, precious kind that competes with sleep, meals eaten while staring at a terminal, and the occasional social obligation.
101+
102+
If it's saved you time, frustration, or a trip to the Google ecosystem, please consider supporting its development!
85103

86-
Want to help out? You can find all the details in our `donation guide <./docs/DONATE.rst>`_.
104+
Wondering how? Check out all the ways to `fuel this project <./docs/DONATE.rst>`_ — coffee, kind words, or cold hard crypto, it's all welcome.
105+
*(No pressure. But the coffee does make the bugs fix themselves slightly faster.)*
87106

88107

89108
Copyright

docs/conf.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
# For the full list of built-in configuration values, see the documentation: https://www.sphinx-doc.org/en/master/usage/configuration.html
88

99
import os
10-
import subprocess
10+
import shutil
11+
import subprocess # nosec B404
1112

1213
from docutils import nodes
1314
from sphinx import addnodes
@@ -26,18 +27,22 @@ def get_version():
2627

2728

2829
def get_revision():
29-
# Try Read the Docs env vars first
30+
# Use Read the Docs environment variables if available
3031
git_rev = os.environ.get('READTHEDOCS_GIT_COMMIT_HASH')
3132
git_id = os.environ.get('READTHEDOCS_GIT_IDENTIFIER')
3233
if git_rev:
3334
git_rev = git_rev[:8]
3435
return f"{git_rev} ({git_id})" if git_id else git_rev
3536

36-
# Local Git fallback
37+
# Fallback to Git CLI
38+
git = shutil.which('git')
39+
if not git:
40+
return None
3741
try:
42+
# Safe: uses list-based arguments (no shell) to prevent injection
3843
return subprocess.check_output(
39-
['git', 'rev-parse', '--short=8', 'HEAD'], stderr=subprocess.DEVNULL
40-
).decode('utf-8').strip()
44+
[git, 'rev-parse', '--short=8', 'HEAD'], stderr=subprocess.DEVNULL
45+
).decode('utf-8').strip() # nosec B603
4146
except Exception:
4247
return None
4348

sonar-project.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
sonar.projectKey=micro5k_google-sync-addon
55
sonar.organization=micro5k
66

7-
# This is the name displayed in the SonarCloud UI
7+
# This is the name displayed in the SonarQube UI
88
sonar.projectName=Google sync add-on
99

1010
# Encoding of the source code. Default is default system encoding

zip-content/META-INF/REUSE.toml

Lines changed: 0 additions & 11 deletions
This file was deleted.

zip-content/REUSE.toml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
version = 1
2+
3+
[[annotations]]
4+
path = [
5+
"META-INF/com/google/android/updater-script*",
6+
"META-INF/CERT.RSA",
7+
"META-INF/CERT.SF",
8+
"META-INF/MANIFEST.MF"
9+
]
10+
SPDX-FileCopyrightText = "NONE"
11+
SPDX-License-Identifier = "CC0-1.0"
12+
13+
14+
[[annotations]]
15+
path = [
16+
"setprop-settings-list.csv"
17+
]
18+
SPDX-FileCopyrightText = "NONE"
19+
SPDX-License-Identifier = "CC0-1.0"
20+
SPDX-FileComment = "This file contains a comprehensive list of all the options configurable via adb shell setprop"

zip-content/setprop-settings-list.csv.license

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)