diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 89f9818..5b3d812 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -6,7 +6,7 @@ version: 2 updates: - package-ecosystem: "nuget" # See documentation for possible values - directory: "/" # Location of package manifests + directory: "/src" # Location of package manifests schedule: interval: "weekly" groups: diff --git a/.github/workflows/publish-documentation.yml b/.github/workflows/publish-documentation.yml new file mode 100644 index 0000000..8a8629d --- /dev/null +++ b/.github/workflows/publish-documentation.yml @@ -0,0 +1,99 @@ +# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json + +name: Build documentation +on: + workflow_run: + workflows: + - tagged-release + types: + - completed +env: + # Name of module and id separated by a slash + INSTANCE: Writerside/hi + # Replace HI with the ID of the instance in capital letters + ARTIFACT: webHelpHI2-all.zip + # Writerside docker image version + DOCKER_VERSION: 233.14272 + # Add the variable below to upload Algolia indexes + # Replace HI with the ID of the instance in capital letters + ALGOLIA_ARTIFACT: algolia-indexes-HI.zip + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Build Writerside docs using Docker + uses: JetBrains/writerside-github-action@v4 + with: + working-directory: ./docs + instance: ${{ env.INSTANCE }} + artifact: ${{ env.ARTIFACT }} + docker-version: ${{ env.DOCKER_VERSION }} + + - name: Upload documentation + uses: actions/upload-artifact@v3 + with: + name: docs + working-directory: ./docs + path: | + artifacts/${{ env.ARTIFACT }} + artifacts/report.json + retention-days: 7 + + # Add the step below to upload Algolia indexes + - name: Upload algolia-indexes + uses: actions/upload-artifact@v3 + with: + name: algolia-indexes + path: artifacts/${{ env.ALGOLIA_ARTIFACT }} + retention-days: 7 + + # Add the job below and artifacts/report.json on Upload documentation step above if you want to fail the build when documentation contains errors + test: + # Requires build job results + needs: build + runs-on: ubuntu-latest + + steps: + - name: Download artifacts + uses: actions/download-artifact@v1 + with: + name: docs + path: artifacts + + - name: Test documentation + uses: JetBrains/writerside-checker-action@v1 + with: + instance: ${{ env.INSTANCE }} + + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + # Requires the build job results + needs: test + runs-on: ubuntu-latest + steps: + - name: Download artifact + uses: actions/download-artifact@v3 + with: + name: docs + + - name: Unzip artifact + run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir + + - name: Setup Pages + uses: actions/configure-pages@v2 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: dir + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 \ No newline at end of file diff --git a/.github/workflows/publish-nuget.yml b/.github/workflows/publish-nuget.yml index e89d41e..a51e5c5 100644 --- a/.github/workflows/publish-nuget.yml +++ b/.github/workflows/publish-nuget.yml @@ -38,6 +38,7 @@ jobs: # Create the NuGet package in the folder from the environment variable NuGetDirectory - run: dotnet pack --configuration Release --output ${{ env.NuGetDirectory }} + working-directory: ./src # Publish the NuGet package as an artifact, so they can be used in the following jobs - uses: actions/upload-artifact@v3 @@ -79,6 +80,7 @@ jobs: uses: actions/setup-dotnet@v3 - name: Run tests run: dotnet test --configuration Release + working-directory: ./src deploy: # Publish only when creating a GitHub Release diff --git a/.gitignore b/.gitignore index dc63f44..8690d60 100644 --- a/.gitignore +++ b/.gitignore @@ -396,4 +396,4 @@ FodyWeavers.xsd # JetBrains Rider *.sln.iml -**/.idea/**/ \ No newline at end of file +**/.idea/** \ No newline at end of file diff --git a/README.md b/README.md index ac9b85b..15316f6 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This package allows you to hook your umbraco website into the fediverse. -Currently there are no settings since the package got developed as a proof of concept for my own blog. +Currently the settings or only settable in the database, you can however view them in the umbraco backoffice The current roadmap is to extend this package with some settings, then harden it for edge cases. diff --git a/docs/Writerside/c.list b/docs/Writerside/c.list new file mode 100644 index 0000000..c4c77a2 --- /dev/null +++ b/docs/Writerside/c.list @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/docs/Writerside/hi.tree b/docs/Writerside/hi.tree new file mode 100644 index 0000000..9f6549e --- /dev/null +++ b/docs/Writerside/hi.tree @@ -0,0 +1,10 @@ + + + + + + + \ No newline at end of file diff --git a/docs/Writerside/redirection-rules.xml b/docs/Writerside/redirection-rules.xml new file mode 100644 index 0000000..320d689 --- /dev/null +++ b/docs/Writerside/redirection-rules.xml @@ -0,0 +1,13 @@ + + + + + + Created after removal of "uActivityPub" from Help Instance + uActivityPub.html + + \ No newline at end of file diff --git a/docs/Writerside/topics/Default-topic.md b/docs/Writerside/topics/Default-topic.md new file mode 100644 index 0000000..bdb12b7 --- /dev/null +++ b/docs/Writerside/topics/Default-topic.md @@ -0,0 +1 @@ +# uActivityPub diff --git a/docs/Writerside/v.list b/docs/Writerside/v.list new file mode 100644 index 0000000..2d12cb3 --- /dev/null +++ b/docs/Writerside/v.list @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/Writerside/writerside.cfg b/docs/Writerside/writerside.cfg new file mode 100644 index 0000000..d9f0168 --- /dev/null +++ b/docs/Writerside/writerside.cfg @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/uActivityPub.Tests/ActivityHelperTests.cs b/src/uActivityPub.Tests/ActivityHelperTests.cs similarity index 100% rename from uActivityPub.Tests/ActivityHelperTests.cs rename to src/uActivityPub.Tests/ActivityHelperTests.cs diff --git a/uActivityPub.Tests/ContentPublishPostHandlerTests.cs b/src/uActivityPub.Tests/ContentPublishPostHandlerTests.cs similarity index 100% rename from uActivityPub.Tests/ContentPublishPostHandlerTests.cs rename to src/uActivityPub.Tests/ContentPublishPostHandlerTests.cs diff --git a/uActivityPub.Tests/GlobalUsings.cs b/src/uActivityPub.Tests/GlobalUsings.cs similarity index 100% rename from uActivityPub.Tests/GlobalUsings.cs rename to src/uActivityPub.Tests/GlobalUsings.cs diff --git a/uActivityPub.Tests/OutboxServiceTests.cs b/src/uActivityPub.Tests/OutboxServiceTests.cs similarity index 100% rename from uActivityPub.Tests/OutboxServiceTests.cs rename to src/uActivityPub.Tests/OutboxServiceTests.cs diff --git a/uActivityPub.Tests/SignatureServiceTests.cs b/src/uActivityPub.Tests/SignatureServiceTests.cs similarity index 100% rename from uActivityPub.Tests/SignatureServiceTests.cs rename to src/uActivityPub.Tests/SignatureServiceTests.cs diff --git a/uActivityPub.Tests/uActivityPub.Tests.csproj b/src/uActivityPub.Tests/uActivityPub.Tests.csproj similarity index 100% rename from uActivityPub.Tests/uActivityPub.Tests.csproj rename to src/uActivityPub.Tests/uActivityPub.Tests.csproj diff --git a/uActivityPub.Tests/uActivitySettingsHelper.cs b/src/uActivityPub.Tests/uActivitySettingsHelper.cs similarity index 100% rename from uActivityPub.Tests/uActivitySettingsHelper.cs rename to src/uActivityPub.Tests/uActivitySettingsHelper.cs diff --git a/uActivityPub.sln b/src/uActivityPub.sln similarity index 100% rename from uActivityPub.sln rename to src/uActivityPub.sln diff --git a/uActivityPub/App_Plugins/uActivityPub/Lang/en-us.xml b/src/uActivityPub/App_Plugins/uActivityPub/Lang/en-us.xml similarity index 100% rename from uActivityPub/App_Plugins/uActivityPub/Lang/en-us.xml rename to src/uActivityPub/App_Plugins/uActivityPub/Lang/en-us.xml diff --git a/uActivityPub/App_Plugins/uActivityPub/backoffice/uactivitypub/dashboard.html b/src/uActivityPub/App_Plugins/uActivityPub/backoffice/uactivitypub/dashboard.html similarity index 100% rename from uActivityPub/App_Plugins/uActivityPub/backoffice/uactivitypub/dashboard.html rename to src/uActivityPub/App_Plugins/uActivityPub/backoffice/uactivitypub/dashboard.html diff --git a/uActivityPub/App_Plugins/uActivityPub/backoffice/uactivitypub/uActivityPub.css b/src/uActivityPub/App_Plugins/uActivityPub/backoffice/uactivitypub/uActivityPub.css similarity index 100% rename from uActivityPub/App_Plugins/uActivityPub/backoffice/uactivitypub/uActivityPub.css rename to src/uActivityPub/App_Plugins/uActivityPub/backoffice/uactivitypub/uActivityPub.css diff --git a/uActivityPub/App_Plugins/uActivityPub/backoffice/uactivitypub/uactivitypub.dashboard.controller.js b/src/uActivityPub/App_Plugins/uActivityPub/backoffice/uactivitypub/uactivitypub.dashboard.controller.js similarity index 100% rename from uActivityPub/App_Plugins/uActivityPub/backoffice/uactivitypub/uactivitypub.dashboard.controller.js rename to src/uActivityPub/App_Plugins/uActivityPub/backoffice/uactivitypub/uactivitypub.dashboard.controller.js diff --git a/uActivityPub/Authorization/SyncAuthorizationPolicies.cs b/src/uActivityPub/Authorization/SyncAuthorizationPolicies.cs similarity index 100% rename from uActivityPub/Authorization/SyncAuthorizationPolicies.cs rename to src/uActivityPub/Authorization/SyncAuthorizationPolicies.cs diff --git a/uActivityPub/Composers/UActivityPubComposer.cs b/src/uActivityPub/Composers/UActivityPubComposer.cs similarity index 100% rename from uActivityPub/Composers/UActivityPubComposer.cs rename to src/uActivityPub/Composers/UActivityPubComposer.cs diff --git a/uActivityPub/Controllers/ActivityPubController.cs b/src/uActivityPub/Controllers/ActivityPubController.cs similarity index 100% rename from uActivityPub/Controllers/ActivityPubController.cs rename to src/uActivityPub/Controllers/ActivityPubController.cs diff --git a/uActivityPub/Controllers/PluginControllers/UActivityPubDashboardApiController.cs b/src/uActivityPub/Controllers/PluginControllers/UActivityPubDashboardApiController.cs similarity index 100% rename from uActivityPub/Controllers/PluginControllers/UActivityPubDashboardApiController.cs rename to src/uActivityPub/Controllers/PluginControllers/UActivityPubDashboardApiController.cs diff --git a/uActivityPub/Controllers/WebfingerController.cs b/src/uActivityPub/Controllers/WebfingerController.cs similarity index 100% rename from uActivityPub/Controllers/WebfingerController.cs rename to src/uActivityPub/Controllers/WebfingerController.cs diff --git a/uActivityPub/Data/Migrations/AddReceivedActivitiesTable.cs b/src/uActivityPub/Data/Migrations/AddReceivedActivitiesTable.cs similarity index 100% rename from uActivityPub/Data/Migrations/AddReceivedActivitiesTable.cs rename to src/uActivityPub/Data/Migrations/AddReceivedActivitiesTable.cs diff --git a/uActivityPub/Data/Migrations/AddUActivitySettingsTable.cs b/src/uActivityPub/Data/Migrations/AddUActivitySettingsTable.cs similarity index 100% rename from uActivityPub/Data/Migrations/AddUActivitySettingsTable.cs rename to src/uActivityPub/Data/Migrations/AddUActivitySettingsTable.cs diff --git a/uActivityPub/Data/Migrations/AddUserKeysTable.cs b/src/uActivityPub/Data/Migrations/AddUserKeysTable.cs similarity index 100% rename from uActivityPub/Data/Migrations/AddUserKeysTable.cs rename to src/uActivityPub/Data/Migrations/AddUserKeysTable.cs diff --git a/uActivityPub/Data/Migrations/RunReceivedActivitiesMigration.cs b/src/uActivityPub/Data/Migrations/RunReceivedActivitiesMigration.cs similarity index 100% rename from uActivityPub/Data/Migrations/RunReceivedActivitiesMigration.cs rename to src/uActivityPub/Data/Migrations/RunReceivedActivitiesMigration.cs diff --git a/uActivityPub/Data/Migrations/RunUActivitySettingsMigration.cs b/src/uActivityPub/Data/Migrations/RunUActivitySettingsMigration.cs similarity index 100% rename from uActivityPub/Data/Migrations/RunUActivitySettingsMigration.cs rename to src/uActivityPub/Data/Migrations/RunUActivitySettingsMigration.cs diff --git a/uActivityPub/Data/Migrations/RunUserKeysMigration.cs b/src/uActivityPub/Data/Migrations/RunUserKeysMigration.cs similarity index 100% rename from uActivityPub/Data/Migrations/RunUserKeysMigration.cs rename to src/uActivityPub/Data/Migrations/RunUserKeysMigration.cs diff --git a/uActivityPub/Data/ReceivedActivities.cs b/src/uActivityPub/Data/ReceivedActivities.cs similarity index 100% rename from uActivityPub/Data/ReceivedActivities.cs rename to src/uActivityPub/Data/ReceivedActivities.cs diff --git a/uActivityPub/Data/UserKeys.cs b/src/uActivityPub/Data/UserKeys.cs similarity index 100% rename from uActivityPub/Data/UserKeys.cs rename to src/uActivityPub/Data/UserKeys.cs diff --git a/uActivityPub/Data/uActivitySettings.cs b/src/uActivityPub/Data/uActivitySettings.cs similarity index 100% rename from uActivityPub/Data/uActivitySettings.cs rename to src/uActivityPub/Data/uActivitySettings.cs diff --git a/uActivityPub/Expansions/SettingsTreeController.cs b/src/uActivityPub/Expansions/SettingsTreeController.cs similarity index 100% rename from uActivityPub/Expansions/SettingsTreeController.cs rename to src/uActivityPub/Expansions/SettingsTreeController.cs diff --git a/uActivityPub/Helpers/CertificateHelper.cs b/src/uActivityPub/Helpers/CertificateHelper.cs similarity index 100% rename from uActivityPub/Helpers/CertificateHelper.cs rename to src/uActivityPub/Helpers/CertificateHelper.cs diff --git a/uActivityPub/Helpers/GravatarHelper.cs b/src/uActivityPub/Helpers/GravatarHelper.cs similarity index 100% rename from uActivityPub/Helpers/GravatarHelper.cs rename to src/uActivityPub/Helpers/GravatarHelper.cs diff --git a/uActivityPub/Helpers/SettingSeedHelper.cs b/src/uActivityPub/Helpers/SettingSeedHelper.cs similarity index 100% rename from uActivityPub/Helpers/SettingSeedHelper.cs rename to src/uActivityPub/Helpers/SettingSeedHelper.cs diff --git a/uActivityPub/Helpers/SingleOrArrayConverter.cs b/src/uActivityPub/Helpers/SingleOrArrayConverter.cs similarity index 100% rename from uActivityPub/Helpers/SingleOrArrayConverter.cs rename to src/uActivityPub/Helpers/SingleOrArrayConverter.cs diff --git a/uActivityPub/Helpers/UserHelper.cs b/src/uActivityPub/Helpers/UserHelper.cs similarity index 100% rename from uActivityPub/Helpers/UserHelper.cs rename to src/uActivityPub/Helpers/UserHelper.cs diff --git a/uActivityPub/Helpers/uActivitySettingKeys.cs b/src/uActivityPub/Helpers/uActivitySettingKeys.cs similarity index 100% rename from uActivityPub/Helpers/uActivitySettingKeys.cs rename to src/uActivityPub/Helpers/uActivitySettingKeys.cs diff --git a/uActivityPub/Models/Activity.cs b/src/uActivityPub/Models/Activity.cs similarity index 100% rename from uActivityPub/Models/Activity.cs rename to src/uActivityPub/Models/Activity.cs diff --git a/uActivityPub/Models/ActivityPubBase.cs b/src/uActivityPub/Models/ActivityPubBase.cs similarity index 100% rename from uActivityPub/Models/ActivityPubBase.cs rename to src/uActivityPub/Models/ActivityPubBase.cs diff --git a/uActivityPub/Models/Actor.cs b/src/uActivityPub/Models/Actor.cs similarity index 100% rename from uActivityPub/Models/Actor.cs rename to src/uActivityPub/Models/Actor.cs diff --git a/uActivityPub/Models/Collection.cs b/src/uActivityPub/Models/Collection.cs similarity index 100% rename from uActivityPub/Models/Collection.cs rename to src/uActivityPub/Models/Collection.cs diff --git a/uActivityPub/Models/Icon.cs b/src/uActivityPub/Models/Icon.cs similarity index 100% rename from uActivityPub/Models/Icon.cs rename to src/uActivityPub/Models/Icon.cs diff --git a/uActivityPub/Models/Note.cs b/src/uActivityPub/Models/Note.cs similarity index 100% rename from uActivityPub/Models/Note.cs rename to src/uActivityPub/Models/Note.cs diff --git a/uActivityPub/Models/OrderedCollection.cs b/src/uActivityPub/Models/OrderedCollection.cs similarity index 100% rename from uActivityPub/Models/OrderedCollection.cs rename to src/uActivityPub/Models/OrderedCollection.cs diff --git a/uActivityPub/Models/PublicKey.cs b/src/uActivityPub/Models/PublicKey.cs similarity index 100% rename from uActivityPub/Models/PublicKey.cs rename to src/uActivityPub/Models/PublicKey.cs diff --git a/uActivityPub/Models/WebFingerResponse.cs b/src/uActivityPub/Models/WebFingerResponse.cs similarity index 100% rename from uActivityPub/Models/WebFingerResponse.cs rename to src/uActivityPub/Models/WebFingerResponse.cs diff --git a/uActivityPub/Notifications/uActivityPubServerVariablesHandler.cs b/src/uActivityPub/Notifications/uActivityPubServerVariablesHandler.cs similarity index 100% rename from uActivityPub/Notifications/uActivityPubServerVariablesHandler.cs rename to src/uActivityPub/Notifications/uActivityPubServerVariablesHandler.cs diff --git a/uActivityPub/Services/ActivityHelper.cs b/src/uActivityPub/Services/ActivityHelper.cs similarity index 100% rename from uActivityPub/Services/ActivityHelper.cs rename to src/uActivityPub/Services/ActivityHelper.cs diff --git a/uActivityPub/Services/ContentPublishPostHandler.cs b/src/uActivityPub/Services/ContentPublishPostHandler.cs similarity index 100% rename from uActivityPub/Services/ContentPublishPostHandler.cs rename to src/uActivityPub/Services/ContentPublishPostHandler.cs diff --git a/uActivityPub/Services/IActivityHelper.cs b/src/uActivityPub/Services/IActivityHelper.cs similarity index 100% rename from uActivityPub/Services/IActivityHelper.cs rename to src/uActivityPub/Services/IActivityHelper.cs diff --git a/uActivityPub/Services/IInboxService.cs b/src/uActivityPub/Services/IInboxService.cs similarity index 100% rename from uActivityPub/Services/IInboxService.cs rename to src/uActivityPub/Services/IInboxService.cs diff --git a/uActivityPub/Services/IOutboxService.cs b/src/uActivityPub/Services/IOutboxService.cs similarity index 100% rename from uActivityPub/Services/IOutboxService.cs rename to src/uActivityPub/Services/IOutboxService.cs diff --git a/uActivityPub/Services/ISignatureService.cs b/src/uActivityPub/Services/ISignatureService.cs similarity index 100% rename from uActivityPub/Services/ISignatureService.cs rename to src/uActivityPub/Services/ISignatureService.cs diff --git a/uActivityPub/Services/ISingedRequestHandler.cs b/src/uActivityPub/Services/ISingedRequestHandler.cs similarity index 100% rename from uActivityPub/Services/ISingedRequestHandler.cs rename to src/uActivityPub/Services/ISingedRequestHandler.cs diff --git a/uActivityPub/Services/IUActivitySettingsService.cs b/src/uActivityPub/Services/IUActivitySettingsService.cs similarity index 100% rename from uActivityPub/Services/IUActivitySettingsService.cs rename to src/uActivityPub/Services/IUActivitySettingsService.cs diff --git a/uActivityPub/Services/InboxService.cs b/src/uActivityPub/Services/InboxService.cs similarity index 100% rename from uActivityPub/Services/InboxService.cs rename to src/uActivityPub/Services/InboxService.cs diff --git a/uActivityPub/Services/OutboxService.cs b/src/uActivityPub/Services/OutboxService.cs similarity index 100% rename from uActivityPub/Services/OutboxService.cs rename to src/uActivityPub/Services/OutboxService.cs diff --git a/uActivityPub/Services/SignatureService.cs b/src/uActivityPub/Services/SignatureService.cs similarity index 100% rename from uActivityPub/Services/SignatureService.cs rename to src/uActivityPub/Services/SignatureService.cs diff --git a/uActivityPub/Services/SingedRequestHandler.cs b/src/uActivityPub/Services/SingedRequestHandler.cs similarity index 100% rename from uActivityPub/Services/SingedRequestHandler.cs rename to src/uActivityPub/Services/SingedRequestHandler.cs diff --git a/uActivityPub/Services/UActivitySettingsService.cs b/src/uActivityPub/Services/UActivitySettingsService.cs similarity index 100% rename from uActivityPub/Services/UActivitySettingsService.cs rename to src/uActivityPub/Services/UActivitySettingsService.cs diff --git a/uActivityPub/buildTransitive/uActivityPub.targets b/src/uActivityPub/buildTransitive/uActivityPub.targets similarity index 100% rename from uActivityPub/buildTransitive/uActivityPub.targets rename to src/uActivityPub/buildTransitive/uActivityPub.targets diff --git a/uActivityPub/uActivityPub.cs b/src/uActivityPub/uActivityPub.cs similarity index 100% rename from uActivityPub/uActivityPub.cs rename to src/uActivityPub/uActivityPub.cs diff --git a/uActivityPub/uActivityPub.csproj b/src/uActivityPub/uActivityPub.csproj similarity index 97% rename from uActivityPub/uActivityPub.csproj rename to src/uActivityPub/uActivityPub.csproj index 8f1fbfa..aafb677 100644 --- a/uActivityPub/uActivityPub.csproj +++ b/src/uActivityPub/uActivityPub.csproj @@ -32,7 +32,7 @@ - + diff --git a/uActivityPub/uActivityPubConstants.cs b/src/uActivityPub/uActivityPubConstants.cs similarity index 100% rename from uActivityPub/uActivityPubConstants.cs rename to src/uActivityPub/uActivityPubConstants.cs