8000 Use Sphinx GithubAction instead of Travis by OskarStark · Pull Request #13061 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

Use Sphinx GithubAction instead of Travis #13061

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.

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

Closed
wants to merge 4 commits into from

Conversation

OskarStark
Copy link
Contributor
@OskarStark OskarStark commented Feb 6, 2020

This PR

  • closes [POC] Use Travis CI GithubAction #12212
  • adds a GithubAction to provide much faster feedback
  • removes TravisCI from the Checks
  • uses the same python version 3.7 like SymfonyCloud, before Travis used 2.7

@javiereguiluz can you explain why do you need on SymfonyCloud:

pip install pip==9.0.1 wheel==0.29.0

@OskarStark OskarStark added this to the 3.4 milestone Feb 6, 2020
@OskarStark OskarStark self-assigned this Feb 6, 2020
@OskarStark OskarStark force-pushed the use-sphinx-github-action branch 6 times, most recently from f8793ec to c12b18b Compare February 6, 2020 08:23
@javiereguiluz
Copy link
Member

I'm sorry but I don't know the internals of this well. Maybe @tucksaun can help us because he set up the SymfonyCloud integration and because he knows everything about SymfonyCloud. Thanks!

@tucksaun
Copy link
Contributor
tucksaun commented Feb 6, 2020

I'm sorry but I don't know the internals of this well. Maybe @tucksaun can help us because he set up the SymfonyCloud integration and because he knows everything about SymfonyCloud. Thanks!

Just ported what used to be on Platform.sh to SymfonyCloud, so sorry I can't tell either 🤷‍♂

@tucksaun
Copy link
Contributor
tucksaun commented Feb 6, 2020

Actually, according to 75e7177:

Pin Python dependencies and install them in a virtualenv
Installing sphinx started to fail about a week ago,
with pip incorrectly trying to remove a Python package
shipped at the system level in Platform.sh environment.

So that would be why

@OskarStark
Copy link
Contributor Author

Ok, but in this case we could add them to the .requirements.txt file? right?

@OskarStark OskarStark force-pushed the use-sphinx-github-action branch from 9d15288 to 948728e Compare February 6, 2020 09:07
@OskarStark
Copy link
Contributor Author

Ok, but in this case we could add them to the .requirements.txt file? right?

Lets see if it works

@tucksaun
Copy link
Contributor
tucksaun commented Feb 6, 2020

Ok, but in this case we could add them to the .requirements.txt file? right?

Probably not because this is a usual command to upgrade pip and then used this updated pip version.

@OskarStark
Copy link
Contributor Author

Unfortunately in this PR there is no SymfonyCloud env deployed. Do we raise the allowed number of ENVs? Or can you force this PR to deploy? @tucksaun

Probably not because this is a usual command to upgrade pip and then used this updated pip version.

Sounds reasonable

@OskarStark OskarStark force-pushed the use-sphinx-github-action branch from f6023cd to 948728e Compare February 6, 2020 11:40
@OskarStark
Copy link
Contributor Author

I dropped the package move, so no blocker here for now. We are good to go

ping @javiereguiluz @xabbuh @wouterj

@tucksaun
Copy link
Contributor
tucksaun commented Feb 6, 2020

Unfortunately in this PR there is no SymfonyCloud env deployed. Do we raise the allowed number of ENVs? Or can you force this PR to deploy? @tucksaun

Actually it is deployed... don't know why the status is not updated 🤔

@OskarStark
Copy link
Contributor Author

RTM from my side

Copy link
Contributor
@localheinz localheinz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

8000

👍

runs-on: ubuntu-latest
steps:
- name: "Checkout"
uses: actions/checkout@v2
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about introducing a bit of vertical whitespace?

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index a019ca7a1..6fa41f61f 100644
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -11,30 +11,42 @@ name: CI
 jobs:
     build:
         name: Build
+
         runs-on: ubuntu-latest
+
         steps:
             -   name: "Checkout"
                 uses: actions/checkout@v2
+
             -   name: "Set up Python 3.x"
                 uses: actions/setup-python@v1
                 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)"
+
             -   name: "Install Sphinx dependencies"
                 run: sudo apt-get install python-dev build-essential
+
             -   name: "Install Sphinx"
                 run: pip install --user sphinx
+
             -   name: "INstall custom requirements via pip"
                 run: pip install -r _build/.requirements.txt
+
             -   name: "Build documentation"
                 run: make -C _build SPHINXOPTS=-nW html
+
     doctor-rst:
         name: DOCtor-RST
+
         runs-on: ubuntu-latest
+
         steps:
             -   name: "Checkout"
                 uses: actions/checkout@v2
+
             -   name: "Run DOCtor-RST"
                 uses: docker://oskarstark/doctor-rst
                 with:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Done ✅

@OskarStark OskarStark force-pushed the use-sphinx-github-action branch from 1d356a5 to 0084ec2 Compare February 10, 2020 08:23
OskarStark added a commit that referenced this pull request Feb 10, 2020
This PR was submitted for the master branch but it was squashed and merged into the 3.4 branch instead (closes #13061).

Discussion
----------

Use Sphinx GithubAction instead of Travis

This PR

- [x] closes #12212
- [x] adds a GithubAction to provide much faster feedback
- [x] removes TravisCI from the Checks
- [x] uses the same python version `3.7` like SymfonyCloud, before Travis used `2.7`

@javiereguiluz can you explain why do you need on SymfonyCloud:
https://github.com/symfony/symfony-docs/blob/a69aece424ef2dd8a969219f797b1ffb55230097/.symfony.cloud.yaml#L55

Commits
-------

9144aab Address comments by @localheinzwq
5b2a1ca Formatting + name steps
fb25022 Use one workflow file
5f3f62a Use GithubAction instead of Travis
@OskarStark OskarStark deleted the use-sphinx-github-action branch February 10, 2020 08:41
OskarStark added a commit that referenced this pull request Nov 23, 2020
This PR was submitted for the master branch but it was merged into the 4.4 branch instead.

Discussion
----------

GitHub Actions: use docker image for CI build

This is an enhancement to #13061

I think it's beneficial to use docker when possible, which allows contributors to exactly replicate CI conditions.

This PR introduces a local action to do just that.

cc @OskarStark

Commits
-------

e059c5b GitHub Actions: use docker container for CI build
Sign up for free to join 6D40 this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants
0