Merge branch 'master' into remove-discontinued-copy-engine

CONTRIBUTING.md → .github/CONTRIBUTING.md

@@ -5,14 +5,19 @@ You can:
 - Add or improve the support of an application (Check the [TODO][TODO] and
   [TOFIX][TOFIX] tasks and pick one)
 - Improve the Mackup codebase
+- You can triage issues which may include reproducing bug reports or asking for
+  vital information, such as version numbers or reproduction instructions. If
+  you would like to start triaging issues, one easy way to get started is to
+  [subscribe to mackup on CodeTriage](https://www.codetriage.com/lra/mackup).
+  [![Open Source Helpers][CODETRIAGE-IMG]][CODETRIAGE]
 
 To speed up Pull Request (PR) approval and merger into Mackup, please follow
 these guidelines:
 
 - Keep one application supported per PR
 - Add the application to the list of supported applications in
-  [README.md](README.md)
-- Add your change to the WIP section of the [CHANGELOG.md](CHANGELOG.md)
+  [README.md][README.md]
+- Add your change to the WIP section of the [CHANGELOG.md][CHANGELOG.md]
 - Sync configurations should follow the following principles:
   - Syncing should not break the application, and PRs should be tested
   - Syncing should not break any syncing functionality internal to the
@@ -27,3 +32,7 @@ Thank you for your contribution!
 
 [TODO]: https://github.com/lra/mackup/labels/TODO
 [TOFIX]: https://github.com/lra/mackup/labels/TOFIX
+[CODETRIAGE]: https://www.codetriage.com/lra/mackup
+[CODETRIAGE-IMG]: https://www.codetriage.com/lra/mackup/badges/users.svg
+[README.md]: https://github.com/lra/mackup/blob/master/README.md
+[CHANGELOG.md]: https://github.com/lra/mackup/blob/master/CHANGELOG.md

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: ['https://tippin.me/@_LR_']

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+### All submissions
+
+* [ ] I have followed the [Contributing Guidelines](https://github.com/lra/mackup/blob/master/.github/CONTRIBUTING.md)
+* [ ] I have checked to ensure there aren't other open [Pull Requests](https://github.com/lra/mackup/pulls) for the same update/change
+
+### Adding/updating Application X Support
+
+* [ ] This PR is only for one application
+* [ ] It has been added to the list of supported applications in the [README](https://github.com/lra/mackup/blob/master/README.md)
+* [ ] Changes have been added to the WIP section of the [CHANGELOG](https://github.com/lra/mackup/blob/master/CHANGELOG.md)
+* [ ] Syncing does not break the application
+* [ ] Syncing does not compete with any syncing functionality internal to the application
+* [ ] The configuration syncs the minimal set of data
+* [ ] No file specific to the local workstation is synced
+* [ ] No sensitive data is synced
+
+### Improving the Mackup codebase
+
+* [ ] My submission passes the [tests](https://github.com/lra/mackup/tree/master/tests)
+* [ ] I have linted the code locally prior to submission
+* [ ] I have written new tests as applicable
+* [ ] I have added an explanation of what the changes do

.github/workflows/install.yaml

@@ -0,0 +1,40 @@
+name: Test installs
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  install-on-linux:
+    strategy:
+      matrix:
+        os:
+          - "ubuntu-20.04"
+          - "ubuntu-22.04"
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+    runs-on: ${{ matrix.os }}
+    container: python:${{ matrix.python-version }}
+    steps:
+      - uses: actions/checkout@v4
+      - run: pip install .
+      - run: mackup --help
+
+  install-on-macos:
+    strategy:
+      matrix:
+        os:
+          - macos-11
+          - macos-12
+          - macos-13
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - run: pip install .
+      - run: mackup --help

.github/workflows/linelint.yaml

@@ -0,0 +1,19 @@
+# Make sure that all text files end with a newline character.
+# Configure your editor to end every file with a newline character.
+# See <https://stackoverflow.com/a/729795>
+name: linelint
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  linelint:
+    runs-on: ubuntu-latest
+    name: Check if all files end with a newline character
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Linelint
+        uses: fernandrone/linelint@master

.github/workflows/lint.yaml

@@ -0,0 +1,16 @@
+name: Lint Python
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  black:
+    runs-on: ubuntu-latest
+    container: python
+    steps:
+      - run: pip install black
+      - uses: actions/checkout@v4
+      - run: black --check --target-version py310 .

.github/workflows/markdown.yaml

@@ -0,0 +1,17 @@
+name: Lint Markdown
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  mdl:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: articulate/actions-markdownlint@v1
+        with:
+          config: .markdownlint.yaml
+          ignore: 'tests/'

.github/workflows/test.yaml

@@ -0,0 +1,34 @@
+name: Run tests
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  nose-2_7:
+    runs-on: ubuntu-latest
+    container: python:2.7
+    steps:
+      - run: pip install docopt six nose
+      - uses: actions/checkout@v4
+      - run: nosetests --with-coverage --cover-tests --cover-inclusive --cover-branches --cover-package=mackup
+
+  nose:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          # - "3.12" # Installing numpy (1.24.4): Failed
+    container: python:${{ matrix.python-version }}
+    steps:
+      - run: echo "${HOME}/.local/bin" >> $GITHUB_PATH
+      - run: pip install pipx
+      - run: pipx install poetry
+      - uses: actions/checkout@v4
+      - run: make test

.linelint.yml

@@ -0,0 +1,19 @@
+# 'true' will fix files
+autofix: false
+
+# list of paths to ignore, uses gitignore syntaxes (executes before any rule)
+ignore:
+  - tests/fixtures/Library/Application Support/Box/Box Sync/sync_root_folder.txt
+  - tests/fixtures/Library/Mobile Documents/com~apple~CloudDocs/_blank_.md
+
+rules:
+  # checks if file ends in a newline character
+  end-of-file:
+    # set to true to enable this rule
+    enable: true
+
+    # set to true to disable autofix (if enabled globally)
+    disable-autofix: true
+
+    # if true also checks if file ends in a single newline character
+    single-new-line: true

.markdownlint.yaml

@@ -0,0 +1,2 @@
+MD004:
+  style: "dash"

.mdl_style.rb

@@ -0,0 +1,4 @@
+all
+rule 'MD007', :indent => 2
+rule 'MD029', :style => :ordered
+exclude_rule 'MD041'

.mdlrc

@@ -0,0 +1 @@
+style './.mdl_style.rb'