phpstan-src/.github/workflows/apiref.yml at 2.1.x · zonuexe/phpstan-src · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# https://help.github.com/en/categories/automating-your-workflow-with-github-actions

name: "API Reference"

on:
  workflow_dispatch:
  push:
    branches:
      - "2.2.x"
    paths:
      - 'src/**'
      - 'composer.lock'
      - 'apigen/**'
      - '.github/workflows/apiref.yml'

env:
  COMPOSER_ROOT_VERSION: "2.2.x-dev"

concurrency:
  group: apigen-${{ github.ref }} # will be canceled on subsequent pushes in branch
  cancel-in-progress: true

jobs:
  apigen:
    name: "Run ApiGen"

    runs-on: "ubuntu-latest"
    timeout-minutes: 60

    steps:
      - name: Harden the runner (Audit all outbound calls)
        uses: step-security/harden-runner@9af89fc71515a100421586dfdb3dc9c984fbf411 # v2.19.4
        with:
          egress-policy: audit

      - name: "Checkout"
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

      - name: "Install PHP"
        uses: "shivammathur/setup-php@7c071dfe9dc99bdf297fa79cb49ea005b9fcadbc" # v2.37.1
        with:
          coverage: "none"
          php-version: "8.2"

      - uses: "ramsey/composer-install@65e4f84970763564f46a70b8a54b90d033b3bdda" # v4.0.0

      - name: "Install ApiGen dependencies"
        uses: "ramsey/composer-install@65e4f84970763564f46a70b8a54b90d033b3bdda" # v4.0.0
        with:
          working-directory: "apigen"

      - name: "Run ApiGen"
        run: "apigen/vendor/bin/apigen -c apigen/apigen.neon --output docs -- src vendor/nikic/php-parser vendor/ondrejmirtes/better-reflection vendor/phpstan/phpdoc-parser"

      - name: "Upload docs"
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: docs
          path: docs

  deploy:
    name: "Deploy"
    needs:
      - apigen
    if: github.repository_owner == 'phpstan'
    runs-on: "ubuntu-latest"
    steps:
      - name: Harden the runner (Audit all outbound calls)
        uses: step-security/harden-runner@9af89fc71515a100421586dfdb3dc9c984fbf411 # v2.19.4
        with:
          egress-policy: audit

      - name: "Install Node"
        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          node-version: "16"

      - name: "Download docs"
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: docs
          path: docs

      - name: "Sync with S3"
        uses: jakejarvis/s3-sync-action@be0c4ab89158cac4278689ebedd8407dd5f35a83 # v0.5.1
        with:
          args: --exclude '.git*/*' --follow-symlinks
        env:
          SOURCE_DIR: './docs'
          DEST_DIR: ${{ github.ref_name }}
          AWS_REGION: 'eu-west-1'
          AWS_S3_BUCKET: "web-apiref.phpstan.org"
          AWS_ACCESS_KEY_ID: ${{ secrets.APIREF_AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.APIREF_AWS_SECRET_ACCESS_KEY }}

      - name: "Invalidate CloudFront"
        uses: chetan/invalidate-cloudfront-action@6adb1f613f4102ad81cd08a7ba83b8abe490cb8d # v2.4.2
        env:
          DISTRIBUTION: "E37G1C2KWNAPBD"
          PATHS: '/${{ github.ref_name }}/*'
          AWS_REGION: 'eu-west-1'
          AWS_ACCESS_KEY_ID: ${{ secrets.APIREF_AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.APIREF_AWS_SECRET_ACCESS_KEY }}

      - uses: peter-evans/repository-dispatch@28959ce8df70de7be546dd1250a005dd32156697 # v4.0.1
        with:
          token: ${{ secrets.PHPSTAN_BOT_TOKEN }}
          repository: "phpstan/phpstan"
          event-type: check_website_links

      - name: "Check for broken links"
        uses: ScholliYT/Broken-Links-Crawler-Action@21eab52f98097989d343116dbbd46dc4541b849b # v3.3.2
        with:
          website_url: 'https://apiref.phpstan.org/${{ github.ref_name }}/index.html'
          resolve_before_filtering: 'true'
          verbose: 'warning'
          max_retry_time: 30
          max_retries: 5