Skip to content

Enable code blocks #17102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 3, 2022
Merged

Enable code blocks #17102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 64 additions & 69 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,72 +74,67 @@ jobs:
with:
args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache

# symfony-code-block-checker:
# name: Code Blocks
# runs-on: Ubuntu-20.04
# continue-on-error: true
# steps:
# - name: Checkout code
# uses: actions/checkout@v2
# with:
# path: 'docs'

# - name: Set-up PHP
# uses: shivammathur/setup-php@v2
# with:
# php-version: 8.1
# coverage: none

# - name: Fetch branch from where the PR started
# working-directory: docs
# run: git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/*

# - name: Find modified files
# id: find-files
# working-directory: docs
# run: echo "::set-output name=files::$(git diff --name-only origin/${{ github.base_ref }} HEAD | grep ".rst" | tr '\n' ' ')"

# - name: Get composer cache directory
# id: composercache
# working-directory: docs/_build
# run: echo "::set-output name=dir::$(composer config cache-files-dir)"

# - name: Cache dependencies
# if: ${{ steps.find-files.outputs.files }}
# uses: actions/cache@v2
# with:
# path: ${{ steps.composercache.outputs.dir }}
# key: ${{ runner.os }}-composer-codeBlocks-${{ hashFiles('_checker/composer.lock', '_sf_app/composer.lock') }}
# restore-keys: ${{ runner.os }}-composer-codeBlocks-

# - name: Install dependencies
# if: ${{ steps.find-files.outputs.files }}
# run: composer create-project symfony-tools/code-block-checker:@dev _checker

# - name: Allow Flex
# if: ${{ steps.find-files.outputs.files }}
# run: |
# composer config --no-plugins allow-plugins.symfony/flex true

# - name: Install test application
# if: ${{ steps.find-files.outputs.files }}
# run: |
# git clone -b ${{ github.base_ref }} --depth 5 --single-branch https://github.com/symfony-tools/symfony-application.git _sf_app
# cd _sf_app
# composer update

# - name: Generate baseline
# if: ${{ steps.find-files.outputs.files }}
# working-directory: docs
# run: |
# CURRENT=$(git rev-parse HEAD)
# git checkout -m ${{ github.base_ref }}
# ../_checker/code-block-checker.php verify:docs `pwd` ${{ steps.find-files.outputs.files }} --generate-baseline=baseline.json --symfony-application=`realpath ../_sf_app`
# git checkout -m $CURRENT
# cat baseline.json

# - name: Verify examples
# if: ${{ steps.find-files.outputs.files }}
# working-directory: docs
# run: |
# ../_checker/code-block-checker.php verify:docs `pwd` ${{ steps.find-files.outputs.files }} --baseline=baseline.json --output-format=github --symfony-application=`realpath ../_sf_app`
symfony-code-block-checker:
name: Code Blocks
runs-on: Ubuntu-20.04
continue-on-error: true
steps:
- name: Checkout code
uses: actions/checkout@v2
with:
path: 'docs'

- name: Set-up PHP
uses: shivammathur/setup-php@v2
with:
php-version: 8.1
coverage: none

- name: Fetch branch from where the PR started
working-directory: docs
run: git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/*

- name: Find modified files
id: find-files
working-directory: docs
run: echo "::set-output name=files::$(git diff --name-only origin/${{ github.base_ref }} HEAD | grep ".rst" | tr '\n' ' ')"

- name: Get composer cache directory
id: composercache
working-directory: docs/_build
run: echo "::set-output name=dir::$(composer config cache-files-dir)"

- name: Cache dependencies
if: ${{ steps.find-files.outputs.files }}
uses: actions/cache@v2
with:
path: ${{ steps.composercache.outputs.dir }}
key: ${{ runner.os }}-composer-codeBlocks-${{ hashFiles('_checker/composer.lock', '_sf_app/composer.lock') }}
restore-keys: ${{ runner.os }}-composer-codeBlocks-

- name: Install dependencies
if: ${{ steps.find-files.outputs.files }}
run: composer create-project symfony-tools/code-block-checker:@dev _checker

- name: Install test application
if: ${{ steps.find-files.outputs.files }}
run: |
git clone -b ${{ github.base_ref }} --depth 5 --single-branch https://github.com/symfony-tools/symfony-application.git _sf_app
cd _sf_app
composer update

- name: Generate baseline
if: ${{ steps.find-files.outputs.files }}
working-directory: docs
run: |
CURRENT=$(git rev-parse HEAD)
git checkout -m ${{ github.base_ref }}
../_checker/code-block-checker.php verify:docs `pwd` ${{ steps.find-files.outputs.files }} --generate-baseline=baseline.json --symfony-application=`realpath ../_sf_app`
git checkout -m $CURRENT
cat baseline.json

- name: Verify examples
if: ${{ steps.find-files.outputs.files }}
working-directory: docs
run: |
../_checker/code-block-checker.php verify:docs `pwd` ${{ steps.find-files.outputs.files }} --baseline=baseline.json --output-format=github --symfony-application=`realpath ../_sf_app`
5 changes: 4 additions & 1 deletion _build/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@
"preferred-install": {
"*": "dist"
},
"sort-packages": true
"sort-packages": true,
"allow-plugins": {
"symfony/flex": true
}
},
"require": {
"php": ">=7.4",
Expand Down
1 change: 0 additions & 1 deletion security.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
Security
========


Symfony provides many tools to secure your application. Some HTTP-related
security tools, like :doc:`secure session cookies </session>` and
:doc:`CSRF protection </security/csrf>` are provided by default. The
Expand Down