From 36e437a2e4c2ff659968f7cfdff6dec9d41fefaa Mon Sep 17 00:00:00 2001 From: david-swift Date: Mon, 7 Oct 2024 11:18:13 +0200 Subject: [PATCH] Migrate to the Aparoksha Gitea instance --- .github/PULL_REQUEST_TEMPLATE.md | 3 -- .github/workflows/docs.yml | 43 ++++++++++----------------- .github/workflows/swiftlint.yml | 8 ++--- .gitignore | 2 -- .spi.yml | 2 +- .swiftlint.yml | 5 ---- CONTRIBUTING.md | 50 -------------------------------- Package.swift | 10 +++---- README.md | 27 ++++++++--------- Sources/Demo/Demo.swift | 4 +-- 10 files changed, 40 insertions(+), 114 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f0ed3f3..cce03ae 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,4 @@ ## Steps -- [ ] Add your name or username and a link to your GitHub profile into the [Contributors.md][1] file. - [ ] Build the project on your machine. If it does not compile, fix the errors. - [ ] Describe the purpose and approach of your pull request below. - [ ] Submit the pull request. Thank you very much for your contribution! @@ -10,5 +9,3 @@ _If there is a related issue, add the link._ ## Approach _Describe how this pull request solves the problem or adds the feature._ - -[1]: /Contributors.md diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ce161e3..adf3a49 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,54 +3,43 @@ name: Deploy Docs on: push: branches: ["main"] - workflow_dispatch: - -permissions: - contents: read - pages: write - id-token: write - -concurrency: - group: "pages" - cancel-in-progress: true jobs: - Deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: macos-15 + publish: + runs-on: david-macbook steps: - uses: actions/checkout@v4 + - name: Build Docs - name: Install Libadwaita run: | brew update - brew install libadwaita + brew upgrade libadwaita sed -i '' 's/-I..includedir.//g' $(brew --prefix)/Library/Homebrew/os/mac/pkgconfig/*/libffi.pc - name: Clone DocC Repo run: | - git clone https://github.com/AparokshaUI/Adwaita.docc Sources/Adwaita/Adwaita.docc + git clone https://git.aparoksha.dev/aparoksha/adwaita.docc Sources/Adwaita/Adwaita.docc rm Sources/Adwaita/Adwaita.docc/LICENSE.md rm Sources/Adwaita/Adwaita.docc/README.md y | rm -r Sources/Adwaita/Adwaita.docc/.git - - name: Build Docs run: | xcrun xcodebuild docbuild \ -scheme Adwaita \ -destination 'generic/platform=macOS' \ - -derivedDataPath "$PWD/.derivedData" + -derivedDataPath "$PWD/.derivedData" \ + -skipPackagePluginValidation xcrun docc process-archive transform-for-static-hosting \ "$PWD/.derivedData/Build/Products/Debug/Adwaita.doccarchive" \ --output-path "docs" \ - --hosting-base-path "adwaita-swift" + --hosting-base-path "/" - name: Modify Docs run: | - echo "" > docs/index.html; + echo "

Please enable JavaScript to view the documentation here.

" > docs/index.html; sed -i '' 's/,2px/,10px/g' docs/css/index.*.css - - name: Upload Artifact - uses: actions/upload-pages-artifact@v3 + - name: Upload + uses: wangyucode/sftp-upload-action@v2.0.2 with: - path: 'docs' - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 + host: 'volans.uberspace.de' + username: 'akforum' + password: ${{ secrets.password }} + localDir: 'docs' + remoteDir: '/var/www/virtual/akforum/adwaita-swift.aparoksha.dev/' \ No newline at end of file diff --git a/.github/workflows/swiftlint.yml b/.github/workflows/swiftlint.yml index 5348bdb..ed7c3ad 100644 --- a/.github/workflows/swiftlint.yml +++ b/.github/workflows/swiftlint.yml @@ -3,17 +3,17 @@ name: SwiftLint on: push: paths: - - '.github/workflows/swiftlint.yml' + - '.gitea/workflows/swiftlint.yml' - '.swiftlint.yml' - '**/*.swift' pull_request: paths: - - '.github/workflows/swiftlint.yml' + - '.gitea/workflows/swiftlint.yml' - '.swiftlint.yml' - '**/*.swift' workflow_dispatch: paths: - - '.github/workflows/swiftlint.yml' + - '.gitea/workflows/swiftlint.yml' - '.swiftlint.yml' - '**/*.swift' @@ -21,7 +21,7 @@ jobs: SwiftLint: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v4 - name: SwiftLint uses: norio-nomura/action-swiftlint@3.2.1 with: diff --git a/.gitignore b/.gitignore index fd02e03..d8f4771 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,4 @@ DerivedData/ /Package.resolved .Ulysses-Group.plist /.docc-build -/io.github.AparokshaUI.Generation.json -/io.github.AparokshaUI.swiftlint.json /.vscode diff --git a/.spi.yml b/.spi.yml index 357f277..0614bf4 100644 --- a/.spi.yml +++ b/.spi.yml @@ -1,6 +1,6 @@ version: 1 external_links: - documentation: "https://aparokshaui.github.io/adwaita-swift/" + documentation: "https://adwaita-swift.aparoksha.dev/" builder: configs: - platform: linux diff --git a/.swiftlint.yml b/.swiftlint.yml index 9a036b1..cbb68f0 100644 --- a/.swiftlint.yml +++ b/.swiftlint.yml @@ -91,11 +91,6 @@ disabled_rules: # Custom Rules custom_rules: - github_issue: - name: 'GitHub Issue' - regex: '//.(TODO|FIXME):.(?!.*(https://github\.com/AparokshaUI/Adwaita/issues/\d))' - message: 'The related GitHub issue must be included in a TODO or FIXME.' - severity: warning fatal_error: name: 'Fatal Error' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index ecf05f1..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,50 +0,0 @@ -# Contributing - -Thank you very much for taking the time for contributing to this project. - -## Report a Bug -Just open a new issue on GitHub and describe the bug. It helps if your description is detailed. Thank you very much for your contribution! - -## Suggest a New Feature -Just open a new issue on GitHub and describe the idea. Thank you very much for your contribution! - -### Suggest a New Component -If you want to be able to access a component from Libadwaita or GTK that is currently not available in Adwaita, you can add it to [Libadwaita](https://github.com/AparokshaUI/Libadwaita). -If you want to add an Adwaita interface for an already existing GTUI widget, open an issue. - -## Pull Requests -I am happy for every pull request, you do not have to follow these guidelines. However, it might help you to understand the project structure and make it easier for me to merge your pull request. Thank you very much for your contribution! - -### 1. Fork & Clone this Project -Start by clicking on the `Fork` button at the top of the page. Then, clone this repository to your computer. - -### 2. Open the Project -Open the project folder in GNOME Builder, Xcode or another IDE. - -### 3. Understand the Project Structure -- The `README.md` file contains a description of the app or package. -- The `Contributors.md` file contains the names or usernames of all the contributors with a link to their GitHub profile. -- The `LICENSE.md` contains an GPL-3.0 license. -- `CONTRIBUTING.md` is this file. -- Directory `Icons` that contains PNG and PXD (Pixelmator Pro) files for the images used in the app and guides. -- `Sources` contains the source code of the project. - - `Adwaita` contains the source code of the project. - - `Adwaita.docc` contains documentation. - - `Model` is the directory with Adwaita's basis. - - `Data Flow` contains property wrappers and protocols required for managing the updates of a view. - - `Extensions` contains all the extensions of types that are not defined in this project. - - `User Interface` contains protocols and structures that are the basis of presenting content to the user. - - `View` contains structures that conform to the `View` protocol and provide an easier-to-use wrapper around a GTUI `NativeWidgetPeer` type. - - `Window` contains structures that conform to the `Window` protocol and simplify the creation of different types of windows. - - `CAdw` contains the reference to the C library. - - `Generation` contains the code for the auto-generation of Adwaita and Gtk widgets. -- `Tests` contains an example application for testing `Adwaita`. - -### 4. Edit the Code -Edit the code. If you add a new type, add documentation in the code. - -### 5. Commit to the Fork -Commit and push the fork. - -### 6. Pull Request -Open GitHub to submit a pull request. Thank you very much for your contribution! diff --git a/Package.swift b/Package.swift index 2bba102..f11cf8a 100644 --- a/Package.swift +++ b/Package.swift @@ -23,10 +23,10 @@ let package = Package( ) ], dependencies: [ - .package(url: "https://github.com/AparokshaUI/Meta", branch: "main"), - .package(url: "https://github.com/AparokshaUI/meta-sqlite", branch: "main"), + .package(url: "https://git.aparoksha.dev/aparoksha/meta", branch: "main"), + .package(url: "https://git.aparoksha.dev/aparoksha/meta-sqlite", branch: "main"), .package( - url: "https://github.com/david-swift/LevenshteinTransformations", + url: "https://git.aparoksha.dev/aparoksha/levenshtein-transformations", from: "0.1.1" ), .package(url: "https://github.com/CoreOffice/XMLCoder", from: "0.17.1") @@ -40,8 +40,8 @@ let package = Package( name: "Adwaita", dependencies: [ "CAdw", - .product(name: "LevenshteinTransformations", package: "LevenshteinTransformations"), - .product(name: "Meta", package: "Meta"), + .product(name: "LevenshteinTransformations", package: "levenshtein-transformations"), + .product(name: "Meta", package: "meta"), .product(name: "MetaSQLite", package: "meta-sqlite") ] ), diff --git a/README.md b/README.md index 55a2d00..4d3238a 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,12 @@

- + Documentation · - - GitHub + + Code

@@ -56,7 +56,7 @@ More examples are available in the [demo app][1]. _Adwaita_’s main goal is to provide an easy-to-use interface for creating GNOME apps. The backend should stay as simple as possible, while not limiting the possibilities there are with [Libadwaita][7] and [GTK][8]. -If you want to use _Adwaita_ in a project, but there are widgets missing, open an [issue on GitHub][9]. +If you want to use _Adwaita_ in a project, but there are widgets missing, open an [issue][9]. Find more information about the project's motivation in [this blog post](https://www.swift.org/blog/adwaita-swift/). @@ -87,36 +87,36 @@ brew install libadwaita 2. Open the `Package.swift` file. 3. Into the `Package` initializer, under `dependencies`, paste: ```swift -.package(url: "https://github.com/AparokshaUI/Adwaita", from: "0.1.0") +.package(url: "https://git.aparoksha.dev/aparoksha/adwaita-swift", from: "0.1.0") ``` ## Usage I recommend using the [template repository](https://github.com/AparokshaUI/AdwaitaTemplate) as a starting point. -Follow the [interactive tutorial](https://aparokshaui.github.io/adwaita-swift/tutorials/table-of-contents) or [read the docs](https://aparokshaui.github.io/adwaita-swift/documentation/adwaita) in order to get to know _Adwaita for Swift_. +Follow the [interactive tutorial](https://adwaita-swift.aparoksha.dev//tutorials/table-of-contents) or [read the docs](https://adwaita-swift.aparoksha.dev/) in order to get to know _Adwaita for Swift_. ## Thanks ### Dependencies -- [XMLCoder][18] licensed under the [MIT license][19] -- [Levenshtein Transformations](https://github.com/david-swift/LevenshteinTransformations) licensed under the [MIT license](https://github.com/david-swift/LevenshteinTransformations/blob/main/LICENSE.md) +- [XMLCoder][18] licensed under the [MIT License][19] +- [Levenshtein Transformations](https://git.aparoksha.dev/aparoksha/levenshtein-transformations) licensed under the [MIT License](https://git.aparoksha.dev/aparoksha/levenshtein-transformations/src/branch/main/LICENSE.md) +- [Meta](https://git.aparoksha.dev/aparoksha/meta) licensed under the [MIT License](https://git.aparoksha.dev/aparoksha/meta/src/branch/main/LICENSE.md) +- [SQLite for Meta](https://git.aparoksha.dev/aparoksha/meta-sqlite) licensed under the [MIT License](https://git.aparoksha.dev/aparoksha/meta-sqlite/src/branch/main/LICENSE.md) ### Other Thanks -- The [contributors][20] - The auto-generation of widgets is based on [Swift Cross UI](https://github.com/stackotter/swift-cross-ui) - [SwiftLint][21] for checking whether code style conventions are violated - The programming language [Swift][22] -[1]: Tests/ +[1]: Sources/Demo/ [2]: #goals [4]: #installation [5]: #usage [6]: #thanks [7]: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/index.html [8]: https://docs.gtk.org/gtk4/ -[9]: https://github.com/AparokshaUI/Adwaita/issues -[10]: https://github.com/AparokshaUI/Libadwaita +[9]:https://git.aparoksha.dev/aparoksha/adwaita-swift/issues [11]: https://brew.sh [12]: user-manual/GettingStarted.md [13]: user-manual/Basics/HelloWorld.md @@ -126,10 +126,7 @@ Follow the [interactive tutorial](https://aparokshaui.github.io/adwaita-swift/tu [17]: user-manual/Advanced/CreatingWidgets.md [18]: https://github.com/CoreOffice/XMLCoder [19]: https://github.com/CoreOffice/XMLCoder/blob/main/LICENSE -[20]: Contributors.md [21]: https://github.com/realm/SwiftLint [22]: https://github.com/apple/swift -[23]: https://github.com/SourceDocs/SourceDocs [image-1]: Icons/Counter.png -[image-2]: Icons/Demo.png diff --git a/Sources/Demo/Demo.swift b/Sources/Demo/Demo.swift index a0bb33d..aad5c16 100644 --- a/Sources/Demo/Demo.swift +++ b/Sources/Demo/Demo.swift @@ -133,8 +133,8 @@ struct Demo: App { developer: "david-swift", version: "Test", icon: .default(icon: .applicationXExecutable), - website: .init(string: "https://aparokshaui.github.io/adwaita-swift/"), - issues: .init(string: "https://github.com/AparokshaUI/adwaita-swift/issues") + website: .init(string: "https://adwaita-swift.aparoksha.dev/"), + issues: .init(string: "https://git.aparoksha.dev/aparoksha/adwaita-swift/issues") ) }