Skip to content

Commit

Permalink
simplify workflow and update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
JAlvarezJarreta committed May 28, 2024
1 parent 248051b commit 231115f
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 73 deletions.
27 changes: 8 additions & 19 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,7 @@

name: "CI"

on:
push:
paths:
- '.github/actions/**'
- '.github/workflows/ci.yml'
- 'src/ensembl/**'
- 'tests/**'
- 'pyproject.toml'

pull_request:
paths:
- '.github/actions/**'
- '.github/workflows/ci.yml'
- 'src/ensembl/**'
- 'tests/**'
- 'pyproject.toml'
on: [push, pull_request]

permissions: write-all

Expand Down Expand Up @@ -109,12 +94,16 @@ jobs:
message: ${{ steps.coverage_report.outputs.coverage }}
color: ${{ steps.coverage_report.outputs.color }}

- name: Deploy coverage report to GitHub pages
- name: Build documentation
if: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
run: |
mkdocs build
- name: Deploy documentation to GitHub Pages
if: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
uses: peaceiris/actions-gh-pages@v4
with:
publish_branch: mkdocs
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./reports/htmlcov
destination_dir: ./site/coverage
publish_dir: ./site
force_orphan: true
52 changes: 0 additions & 52 deletions .github/workflows/docs.yml

This file was deleted.

3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/Ensembl/ensembl-utils/blob/main/LICENSE)
[![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/JAlvarezJarreta/019787fcdec96f05d6c53367bbf2b949/raw/ensembl-utils_badge.json)](https://ensembl.github.io/ensembl-utils/coverage)
[![CI](https://github.com/Ensembl/ensembl-utils/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Ensembl/ensembl-utils/actions/workflows/ci.yml)
[![Docs](https://github.com/Ensembl/ensembl-utils/actions/workflows/docs.yml/badge.svg?branch=main)](https://ensembl.github.io/ensembl-utils/)

Centralise generic Python utils used by other project within Ensembl design to facilitate frequent tasks such as input file path checks, archive files IO manipulation or logging setup, among others.

For more information, please consult this repository's [GitHub pages](https://ensembl.github.io/ensembl-utils/).

## Getting Started

### Basic installation
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ plugins:
show_symbol_type_toc: true
- coverage:
page_name: coverage
html_report_dir: htmlcov
html_report_dir: ./reports/htmlcov

nav:
- Home: index.md
Expand Down

1 comment on commit 231115f

@github-actions
Copy link

Choose a reason for hiding this comment

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

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/ensembl/utils
   __init__.py40100% 
   archive.py300100% 
   argparse.py760100% 
   logging.py190100% 
   rloader.py450100% 
TOTAL1740100% 

Tests Skipped Failures Errors Time
38 0 💤 0 ❌ 0 🔥 0.384s ⏱️

Please sign in to comment.