Skip to content

Commit

Permalink
Update continuous integration steps
Browse files Browse the repository at this point in the history
Updates CI yaml steps (azure pipelines and github action) to download
pip requirements via the pyproject.toml rather then a requirements file.

Removes all requirements files.
  • Loading branch information
Javagedes committed May 11, 2023
1 parent 90fed73 commit 430bff4
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 23 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/CIRunner.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@ jobs:
- name: Install pip Dependencies
run: |
python -m pip install --upgrade pip
pip install --upgrade -r requirements.txt
pip install --upgrade -r docs/user/requirements.txt
pip install -e .
pip install --upgrade -e .[dev,docs]
- name: Set up Node ${{ inputs.node-version }}
uses: actions/setup-node@v3
Expand Down
3 changes: 1 addition & 2 deletions .github/workflows/UnitTestRunner.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@ jobs:
- name: Install pip Dependencies
run: |
python -m pip install --upgrade pip
pip install --upgrade -r requirements.txt
pip install -e .
pip install --upgrade -e .[dev]
- name: Run Unit Tests
run: coverage run -m pytest
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/doc-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install --upgrade -r docs/user/requirements.txt
pip install --upgrade -e .[docs]
- name: Build Documentation
run: |
Expand Down
20 changes: 7 additions & 13 deletions docs/contributor/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,19 @@
6. change working directory to the root of the cloned repository.
3. Install development dependencies into this virtual environment
``` cmd
pip install --upgrade -r requirements.txt
```
4. Uninstall any copy of edk2-pytool-library
3. Uninstall any copy of edk2-pytool-library
``` cmd
pip uninstall edk2-pytool-library
```
5. Install from local source (run command from root of repo)
4. Install from local source (run command from root of repo)
``` cmd
pip install -e .
pip install -e .[dev]
```
6. To support spell checking / validation NodeJs and cspell are used.
5. To support spell checking / validation NodeJs and cspell are used.
* Install NodeJS from <https://nodejs.org/en/>
* Use npm to install cspell.
Expand All @@ -64,7 +58,7 @@
* <https://github.com/streetsidesoftware/cspell>
* <https://www.npmjs.com/package/cspell>
7. To support linting the markdown files NodeJs and markdownlint are used.
6. To support linting the markdown files NodeJs and markdownlint are used.
* Install NodeJS from <https://nodejs.org/en/>
* Use npm to install markdownlint-cli.
Expand Down Expand Up @@ -148,15 +142,15 @@ The following command will enable this pre-commit to prior to each commit. If it
issues it will fail to commit until they are fixed.
```bash
pre-commit install -c githooks/basic-pre-commit-config.yaml
pre-commit install -c .githooks/basic-pre-commit-config.yaml
```

#### Running across the entire repository (Manually)

This step is entirely manual but gives a good example of what the behavior of this tool will be.

```bash
pre-commit run --all-files -c githooks/basic-pre-commit-config.yaml
pre-commit run --all-files -c .githooks/basic-pre-commit-config.yaml
```

#### Uninstalling
Expand Down
4 changes: 2 additions & 2 deletions docs/contributor/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ developing. If not please first do that. Directions on the
1. Install tools

``` cmd
pip install --upgrade -r requirements.publisher.txt
pip install --upgrade -e [publish]
```
2. Build a wheel
``` cmd
python setup.py sdist bdist_wheel
python -m build --sdist --wheel
```
3. Confirm wheel version is aligned with git tag
Expand Down
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,15 +129,15 @@ details.
[![docs]][_docs]

Documentation for the most recent release of edk2-pytool-library is hosted on
[tianocore.org/edk2-pytool-library](https://www.tianocore.org/edk2-pytool-library/)]).
[tianocore.org/edk2-pytool-library](https://www.tianocore.org/edk2-pytool-library/).
Raw documentation is located in the ```docs/``` folder and is split into two
separate categories. The first is located at ```docs/user/``` and is
documentation and API references for those that are using this package in their
own project. Users can generate a local copy of the documentation by executing the
following command from the root of the project:

```cmd
pip install --upgrade -r .\docs\user\requirements.txt
pip install --upgrade -e[docs]
mkdocs serve
```

Expand Down

0 comments on commit 430bff4

Please sign in to comment.