chore: fix links

.github/workflows/cicd.yml → .github/workflows/ci.yaml

@@ -1,4 +1,4 @@
-name: Syrupy CICD
+name: CI
 
 on:
   push:
@@ -10,6 +10,10 @@ env:
   CI: 1
   VENV: .venv
 
+permissions:
+  contents: read
+  checks: write
+
 jobs:
   analysis:
     name: Code Analysis
@@ -24,6 +28,7 @@ jobs:
       - name: Lint
         run: |
           poetry run invoke lint
+
   tests:
     name: Tests
     runs-on: ${{ matrix.os }}
@@ -54,7 +59,7 @@ jobs:
       - name: Upload Coverage
         if: matrix.python-version == '3.12-dev' && matrix.os == 'ubuntu-latest'
         env:
-          CODECOV_TOKEN: "" # FIXME: Needs a new token.
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         shell: bash
         run: ./.github/codecov.sh $GITHUB_EVENT_PATH
 
@@ -87,6 +92,9 @@ jobs:
     runs-on: ubuntu-latest
     if: "github.event_name == 'pull_request' && !contains(github.event.head_commit.message, '[skip ci]')"
     needs: [tests]
+    permissions:
+      contents: write
+      pull-requests: write
     steps:
       - uses: actions/checkout@v4.1.1
       - name: Setup Environment
@@ -100,58 +108,22 @@ jobs:
         with:
           tool: 'pytest'
           output-file-path: benchmarks.json
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+          github-token: ${{ github.token }}
           auto-push: false
           alert-threshold: '200%'
           comment-on-alert: true
           fail-on-alert: false
           comment-always: true
 
-  dry_run:
-    name: Release Test Package
+  required_checks:
+    name: Required Checks
+    needs:
+      - analysis
+      - tests
+      - benchmark
     runs-on: ubuntu-latest
-    # Dry run check does not need to wait for others
-    if: github.event_name == 'pull_request' && github.event.pull_request.head.ref == 'next' && !contains(github.event.head_commit.message, '[skip ci]')
+    if: always()
     steps:
-      - uses: actions/checkout@v4.1.1
-        with:
-          fetch-depth: 0
-      - name: Setup Environment
-        uses: ./.github/actions/setup-env
-      - name: Install project dependencies
-        run: . script/bootstrap
-      - name: Dry Release
-        env:
-          TWINE_USERNAME: __token__
-          TWINE_PASSWORD: "" # FIXME: Needs a new token.
-        run: |
-          poetry run invoke release --dry-run
-
-  release:
-    name: Release
-    runs-on: ubuntu-latest
-    needs: [analysis, tests] # [version_checks]
-    if: github.event_name == 'push' && github.ref == 'refs/heads/main' && !contains(github.event.head_commit.message, '[skip ci]')
-    env:
-      TWINE_USERNAME: __token__
-      TWINE_PASSWORD: "" # FIXME: Needs a new token.
-    steps:
-      - uses: actions/checkout@v4.1.1
-        with:
-          fetch-depth: 0
-          persist-credentials: false
-      - name: Setup Environment
-        uses: ./.github/actions/setup-env
-      - name: Install project dependencies
-        run: . script/bootstrap
-      - name: Release
-        uses: cycjimmy/semantic-release-action@v4.0.0
-        with:
-          branch: main
-          dry_run: false
-          extra_plugins: |
-            @semantic-release/changelog
-            @semantic-release/exec
-            @semantic-release/git
-        env:
-          GITHUB_TOKEN: "" #FIXME: Needs a new token.
+      - name: Fail on error
+        if: contains(needs.*.result, 'failure') || cancelled()
+        run: exit 1

.github/workflows/manual_release.yml → .github/workflows/release.yaml

@@ -1,4 +1,4 @@
-name: Syrupy Manual Release
+name: Release
 
 on:
   workflow_dispatch:
@@ -11,18 +11,19 @@ jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
-    env:
-      TWINE_USERNAME: __token__
-      TWINE_PASSWORD: "" # FIXME: Needs a new token.
+    environment: release
     steps:
       - uses: actions/checkout@v4.1.1
         with:
           fetch-depth: 0
           persist-credentials: false
+
       - name: Setup Environment
         uses: ./.github/actions/setup-env
+
       - name: Install project dependencies
         run: . script/bootstrap
+
       - name: Release
         uses: cycjimmy/semantic-release-action@v4.0.0
         with:
@@ -33,4 +34,6 @@ jobs:
             @semantic-release/exec
             @semantic-release/git
         env:
-          GITHUB_TOKEN: "" # FIXME: Needs a new token.
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_PUBLISH_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.RELEASE_GITHUB_PAT }}

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 :tada: Thanks for taking the time to contribute! :tada:
 
-The following is a set of guidelines for contributing to [syrupy](https://github.com/noahnu/syrupy).
+The following is a set of guidelines for contributing to [syrupy](https://github.com/syrupy-project/syrupy).
 
 These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document.
 
@@ -137,4 +137,4 @@ You can also run `inv lint --fix` to see and solve what issues it can.
 
 ### Issue and Pull Request Labels
 
-Please tag issues and pull requests according to the relevant [github labels](https://github.com/noahnu/syrupy/issues/labels).
+Please tag issues and pull requests according to the relevant [github labels](https://github.com/syrupy-project/syrupy/issues/labels).