Skip to content

Minor change in description #16199

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
Dec 7, 2021
Merged

Minor change in description #16199

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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
15 changes: 14 additions & 1 deletion .doctor-rst.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,30 @@
rules:
american_english: ~
avoid_repetetive_words: ~
blank_line_after_anchor: ~
blank_line_after_directive: ~
blank_line_before_directive: ~
composer_dev_option_not_at_the_end: ~
correct_code_block_directive_based_on_the_content: ~
deprecated_directive_should_have_version: ~
ensure_exactly_one_space_between_link_definition_and_link: ~
ensure_link_definition_contains_valid_url: ~
ensure_order_of_code_blocks_in_configuration_block: ~
extend_abstract_controller: ~
extension_xlf_instead_of_xliff: ~
indention: ~
lowercase_as_in_use_statements: ~
max_blank_lines:
max: 2
max_colons: ~
no_app_console: ~
no_blank_line_after_filepath_in_php_code_block: ~
no_blank_line_after_filepath_in_twig_code_block: ~
no_blank_line_after_filepath_in_xml_code_block: ~
no_blank_line_after_filepath_in_yaml_code_block: ~
no_brackets_in_method_directive: ~
no_composer_req: ~
no_directive_after_shorthand: ~
no_explicit_use_of_code_block_php: ~
no_inheritdoc: ~
no_namespace_after_use_statements: ~
Expand All @@ -34,6 +39,7 @@ rules:
short_array_syntax: ~
space_between_label_and_link_in_doc: ~
space_between_label_and_link_in_ref: ~
string_replacement: ~
typo: ~
unused_links: ~
use_deprecated_directive_instead_of_versionadded: ~
Expand Down Expand Up @@ -65,6 +71,7 @@ whitelist:
- '/``.yml``/'
- '/(.*)\.orm\.yml/' # currently DoctrineBundle only supports .yml
- '/rst-class/'
- /docker-compose\.yml/
lines:
- 'in config files, so the old ``app/config/config_dev.yml`` goes to'
- '#. The most important config file is ``app/config/services.yml``, which now is'
Expand All @@ -73,7 +80,7 @@ whitelist:
- 'The bin/console Command'
- '# username is your full Gmail or Google Apps email address'
- '.. _`LDAP injection`: http://projects.webappsec.org/w/page/13246947/LDAP%20Injection'
- '.. versionadded:: 0.21.0' # Encore
- '.. versionadded:: 1.9.0' # Encore
- '.. versionadded:: 0.28.4' # Encore
- '.. versionadded:: 2.4.0' # SwiftMailer
- '.. versionadded:: 1.30' # Twig
Expand All @@ -83,6 +90,7 @@ whitelist:
- '.. versionadded:: 1.3' # MakerBundle
- '.. versionadded:: 1.8' # MakerBundle
- '.. versionadded:: 1.6' # Flex in setup/upgrade_minor.rst
- '.. versionadded:: 1.0.0' # Encore
- '0 => 123' # assertion for var_dumper - components/var_dumper.rst
- '1 => "foo"' # assertion for var_dumper - components/var_dumper.rst
- '123,' # assertion for var_dumper - components/var_dumper.rst
Expand All @@ -95,3 +103,8 @@ whitelist:
- 'provides a ``loginUser()`` method to simulate logging in in your functional'
- '.. code-block:: twig'
- '.. versionadded:: 3.6' # MonologBundle
- '// bin/console'
- 'End to End Tests (E2E)'
- '.. code-block:: php'
- '.. _`a feature to test applications using Mercure`: https://github.com/symfony/panther#creating-isolated-browsers-to-test-apps-using-mercure-or-websocket'
- '.. End to End Tests (E2E)'
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# GithubActions workflows
/.github/workflows* @OskarStark

# Console
/console* @chalasr
/components/console* @chalasr
Expand Down
155 changes: 95 additions & 60 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
name: CI

on:
push:
branches-ignore:
Expand All @@ -6,83 +8,51 @@ on:
branches-ignore:
- 'github-comments'

name: CI

jobs:
build:
name: Build
symfony-docs-builder-build:
name: Build (symfony-tools/docs-builder)

runs-on: ubuntu-latest

continue-on-error: true

steps:
- name: "Checkout"
uses: actions/checkout@v2

- name: "Set up Python 3.7"
uses: actions/setup-python@v1
- name: "Set-up PHP"
uses: shivammathur/setup-php@v2
with:
python-version: '3.7' # Semantic version range syntax or exact version of a Python version

- name: "Display Python version"
run: python -c "import sys; print(sys.version)"
php-version: 8.0
coverage: none
tools: "composer:v2"

- name: "Install Sphinx dependencies"
run: sudo apt-get install python-dev build-essential
- name: Get composer cache directory
id: composercache
working-directory: _build
run: echo "::set-output name=dir::$(composer config cache-files-dir)"

- name: "Cache pip"
- name: Cache dependencies
uses: actions/cache@v2
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('_build/.requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
path: ${{ steps.composercache.outputs.dir }}
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
restore-keys: ${{ runner.os }}-composer-

- name: "Install Sphinx + requirements via pip"
run: pip install -r _build/.requirements.txt
- name: "Install dependencies"
working-directory: _build
run: composer install --prefer-dist --no-progress

- name: "Build documentation"
run: make -C _build SPHINXOPTS="-nqW -j auto" html
- name: "Build the docs"
working-directory: _build
run: php build.php -vvv

build-php:
name: Symfony doc builder

runs-on: ubuntu-latest

continue-on-error: true

steps:
- name: "Checkout"
uses: actions/checkout@v2

- name: "Set-up PHP"
uses: shivammathur/setup-php@v2
with:
php-version: 7.2
coverage: none
tools: "composer:v2"

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

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

- name: "Install dependencies"
working-directory: _build
run: composer install --prefer-dist --no-progress

- name: "Build the docs"
working-directory: _build
run: php build.php -vvv
- name: Show log file
if: ${{ always() }}
run: cat _build/logs.txt || true

doctor-rst:
name: DOCtor-RST
name: Lint (DOCtor-RST)

runs-on: ubuntu-latest

Expand All @@ -98,7 +68,7 @@ jobs:
id: extract_base_branch

- name: "Cache DOCtor-RST"
uses: actions/cache@v1
uses: actions/cache@v2
with:
path: .cache
key: ${{ runner.os }}-doctor-rst-${{ steps.extract_base_branch.outputs.branch }}
Expand All @@ -107,3 +77,68 @@ jobs:
uses: docker://oskarstark/doctor-rst
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.0
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 _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: 0 additions & 5 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,2 @@
/_build/doctrees
/_build/spelling
/_build/html
/_build/logs.txt
/_build/vendor
/_build/output
*.pyc
48 changes: 0 additions & 48 deletions .symfony.cloud.yaml
View file
Open in desktop

This file was deleted.

11 changes: 0 additions & 11 deletions .symfony/routes.yaml
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion .symfony/services.yaml
View file
Open in desktop

This file was deleted.

16 changes: 0 additions & 16 deletions Dockerfile
View file
Open in desktop

This file was deleted.

Loading