Merge torrust#336: various: change name to torrust-index

b6cfcc3 various: change name to `torrust-index` (Cameron Garnham) Pull request description: small changes included: - move to deployment workflow - move copyright to readme - remove common license files ACKs for top commit: da2ce7: ACK b6cfcc3 Tree-SHA512: 5481623bb6320971ef53f359f2684f9200ba133ded0946572b4028e6a0ebf642bf3e63df69db54e8a540f0117a3b558acd9509a3d2bf066758697f19be9a9811
da2ce7 · Oct 13, 2023 · 272c384 · 272c384
2 parents f43da9e + b6cfcc3
commit 272c384
Show file tree

Hide file tree

Showing 79 changed files with 999 additions and 1,418 deletions.
diff --git a/.github/workflows/coverage.yaml b/.github/workflows/coverage.yaml
@@ -12,27 +12,9 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  secrets:
-    name: Secrets
-    environment: coverage
-    runs-on: ubuntu-latest
-
-    outputs:
-      continue: ${{ steps.check.outputs.continue }}
-
-    steps:
-      - id: check
-        name: Check
-        env:
-          CODECOV_TOKEN: "${{ secrets.CODECOV_TOKEN }}"
-        if: "${{ env.CODECOV_TOKEN != '' }}"
-        run: echo "continue=true" >> $GITHUB_OUTPUT
-
   report:
     name: Report
     environment: coverage
-    needs: secrets
-    if: needs.secrets.outputs.continue == 'true'
     runs-on: ubuntu-latest
     env:
       CARGO_INCREMENTAL: "0"

diff --git a/.github/workflows/deployment.yaml b/.github/workflows/deployment.yaml
@@ -0,0 +1,54 @@
+name: Deployment
+
+on:
+  push:
+    branches:
+      - "releases/**/*"
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        toolchain: [stable, nightly]
+
+    steps:
+      - id: checkout
+        name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - id: setup
+        name: Setup Toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: ${{ matrix.toolchain }}
+
+      - id: test
+        name: Run Unit Tests
+        run: cargo test --tests --benches --examples --workspace --all-targets --all-features
+
+  publish:
+    name: Publish
+    environment: deployment
+    needs: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - id: checkout
+        name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - id: setup
+        name: Setup Toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: stable
+
+      - id: publish
+        name: Publish Crates
+        env:
+          CARGO_REGISTRY_TOKEN: "${{ secrets.TORRUST_UPDATE_CARGO_REGISTRY_TOKEN }}"
+        run: |
+          cargo publish -p torrust-index
diff --git a/.github/workflows/labels.yaml b/.github/workflows/labels.yaml
@@ -29,7 +29,7 @@ jobs:
 
       - id: sync
         name: Apply Labels from File
-        uses: EndBug/label-sync@v2
+        uses: EndBug/label-sync@da00f2c11fdb78e4fae44adac2fdd713778ea3e8
         with:
           config-file: .github/labels.json
           delete-other-labels: true

diff --git a/.github/workflows/publish_crate.yaml b/.github/workflows/publish_crate.yaml
diff --git a/.github/workflows/publish_docker_image.yaml b/.github/workflows/publish_docker_image.yaml
@@ -54,7 +54,7 @@ jobs:
         uses: docker/metadata-action@v4
         with:
           images: |
-            # For example: torrust/index-backend
+            # For example: torrust/index
             "${{ secrets.DOCKER_HUB_USERNAME }}/${{secrets.DOCKER_HUB_REPOSITORY_NAME }}"
           tags: |
             type=ref,event=branch

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
diff --git a/.github/workflows/testing.yaml b/.github/workflows/testing.yaml
@@ -65,9 +65,11 @@ jobs:
         name: Run Lint Checks
         run: cargo clippy --tests --benches --examples --workspace --all-targets --all-features -- -D clippy::correctness -D clippy::suspicious -D clippy::complexity -D clippy::perf -D clippy::style -D clippy::pedantic
 
-      - id: doc
-        name: Run Documentation Checks
-        run: cargo test --doc
+      - id: docs
+        name: Lint Documentation
+        env:
+          RUSTDOCFLAGS: "-D warnings"
+        run: cargo doc --no-deps --bins --examples --workspace --all-features
 
   unit:
     name: Units
@@ -104,6 +106,10 @@ jobs:
         name: Install Intermodal
         run: cargo install imdl
 
+      - id: test-docs
+        name: Run Documentation Tests
+        run: cargo test --doc
+
       - id: test
         name: Run Unit Tests
         run: cargo test --tests --benches --examples --workspace --all-targets --all-features

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -7,16 +7,16 @@
         {
             "type": "lldb",
             "request": "launch",
-            "name": "Debug unit tests in library 'torrust-index-backend'",
+            "name": "Debug unit tests in library 'torrust-index'",
             "cargo": {
                 "args": [
                     "test",
                     "--no-run",
                     "--lib",
-                    "--package=torrust-index-backend"
+                    "--package=torrust-index"
                 ],
                 "filter": {
-                    "name": "torrust-index-backend",
+                    "name": "torrust-index",
                     "kind": "lib"
                 }
             },
@@ -31,7 +31,7 @@
                 "args": [
                     "build",
                     "--bin=main",
-                    "--package=torrust-index-backend"
+                    "--package=torrust-index"
                 ],
                 "filter": {
                     "name": "main",
@@ -50,7 +50,7 @@
                     "test",
                     "--no-run",
                     "--bin=main",
-                    "--package=torrust-index-backend"
+                    "--package=torrust-index"
                 ],
                 "filter": {
                     "name": "main",
@@ -68,7 +68,7 @@
                 "args": [
                     "build",
                     "--bin=import_tracker_statistics",
-                    "--package=torrust-index-backend"
+                    "--package=torrust-index"
                 ],
                 "filter": {
                     "name": "import_tracker_statistics",
@@ -87,7 +87,7 @@
                     "test",
                     "--no-run",
                     "--bin=import_tracker_statistics",
-                    "--package=torrust-index-backend"
+                    "--package=torrust-index"
                 ],
                 "filter": {
                     "name": "import_tracker_statistics",
@@ -105,7 +105,7 @@
                 "args": [
                     "build",
                     "--bin=parse_torrent",
-                    "--package=torrust-index-backend"
+                    "--package=torrust-index"
                 ],
                 "filter": {
                     "name": "parse_torrent",
@@ -124,7 +124,7 @@
                     "test",
                     "--no-run",
                     "--bin=parse_torrent",
-                    "--package=torrust-index-backend"
+                    "--package=torrust-index"
                 ],
                 "filter": {
                     "name": "parse_torrent",
@@ -142,7 +142,7 @@
                 "args": [
                     "build",
                     "--bin=upgrade",
-                    "--package=torrust-index-backend"
+                    "--package=torrust-index"
                 ],
                 "filter": {
                     "name": "upgrade",
@@ -161,7 +161,7 @@
                     "test",
                     "--no-run",
                     "--bin=upgrade",
-                    "--package=torrust-index-backend"
+                    "--package=torrust-index"
                 ],
                 "filter": {
                     "name": "upgrade",
@@ -180,7 +180,7 @@
                     "test",
                     "--no-run",
                     "--test=mod",
-                    "--package=torrust-index-backend"
+                    "--package=torrust-index"
                 ],
                 "filter": {
                     "name": "mod",

diff --git a/COPYRIGHT b/COPYRIGHT