Skip to content

Commit

Permalink
ci: fix linting issues and add checks to CI
Browse files Browse the repository at this point in the history
* closes #491
  • Loading branch information
ntarocco committed Feb 15, 2023
1 parent 1ac4ae8 commit 5cf9bfd
Show file tree
Hide file tree
Showing 8 changed files with 54 additions and 8 deletions.
46 changes: 46 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: CI

on:
push:
branches:
- master
- dev
pull_request:
branches:
- master
- dev
schedule:
# * is a special character in YAML so you have to quote this string
- cron: "0 3 * * 6"
workflow_dispatch:
inputs:
reason:
description: "Reason"
required: false
default: "Manual trigger"

jobs:
Tests:
runs-on: ubuntu-20.04

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

- name: Set up Python 3.9
uses: actions/setup-python@v2
with:
python-version: 3.9

- name: Install dependencies
run: |
pip install -r requirements.txt
pip freeze
- name: Build
run: mkdocs build --strict

- name: Check links
uses: untitaker/[email protected]
with:
args: site/ --github-actions --sources docs/

This comment has been minimized.

Copy link
@slint

slint Feb 15, 2023

Member

My bad, apparently this seems to be added automatically by the GitHub Action... 🤦

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
*DS_Store
site/*
.cache
2 changes: 1 addition & 1 deletion docs/customize/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ Then, open the `templates` folder in `my-site` (your instance) and paste it ther

Edit the Jinja template as you need.

For more information, see the guide [style other pages](/customize/styling/#change-other-pages).
For more information, see the guide [style other pages](look-and-feel/templates.md).

### Custom user registration form

Expand Down
2 changes: 1 addition & 1 deletion docs/customize/other-pids/urns.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ XMETADISS_TYPE_DCTERMS_DCMITYPE = "openaire_type"
```

In order to fully implement xMetaDissPlus with all mandatory fields, the metadata definition has to be expanded by [custom
fields](../../../develop/howtos/cusomt_fields.md).
fields](../../develop/howtos/custom_fields.md).
At first add the file `thesis_types.yaml` to `/app_data/vocabularies`. Then change the `vocabularies.yaml`:

```yaml
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/file_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ _Introduced in InvenioRDM v11_
**Use it at your own risk!**

Fetched files accept two more arguments than a local files on their
[initialization](est_api_drafts_records/#start-draft-file-uploads): _storage\_class_, and
[initialization](rest_api_drafts_records.md#start-draft-file-uploads): _storage\_class_, and
_uri_:

**Parameters**
Expand Down Expand Up @@ -110,7 +110,7 @@ Content-Type: application/json
At this point an asynchronous task will be launched and the file will be transported into
the InvenioRDM instance. Once the file transfer is completed, the status field will be
changed to `completed`. At this point the `storage_class` of the files has also changed
to `L`. The status can be checked using the _files_ url (`/api/records/{id}/draft/files`).
to `L`. The status can be checked using the _files_ url (`/api/records/{id}/draft/files`).
Note, until all the files have been transferred (i.e. their status is `completed`) the
record cannot be published.

Expand All @@ -133,4 +133,4 @@ RECORDS_RESOURCES_FILES_ALLOWED_DOMAINS = [

!!! info "Not supported"

Remote files are currently not supported.
Remote files are currently not supported.
2 changes: 1 addition & 1 deletion docs/releases/versions/version-v10.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ In addition to the many bugs fixed, this release introduces custom fields both f

You can now add custom fields to [bibliographic records](https://inveniordm.docs.cern.ch/customize/custom_fields/records/) and [communities](https://inveniordm.docs.cern.ch/customize/custom_fields/communities/) data models. InvenioRDM supports a wide variety of field types and UI widgets: you can find the full list in the [custom fields](https://inveniordm.docs.cern.ch/customize/custom_fields/records/#reference) and the [UI widgets](https://inveniordm.docs.cern.ch/reference/widgets/) documentation pages.

You can also extend the default components or implement your owns. To get more information, refer to the [custom fields development section](https://inveniordm.docs.cern.ch/develop/topics/custom_fields/) in the documentation.
You can also extend the default components or implement your owns. To get more information, refer to the [custom fields development section](../../develop/howtos/custom_fields.md) in the documentation.

#### Fields in the upload form

Expand Down
2 changes: 1 addition & 1 deletion docs/releases/versions/version-v4.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The [detailed documentation](/customize/authentication/) describes how a new OAu

This month we continued work on vocabularies. Most notably we migrated the resource types from the old to the new vocabulary and made them easily customizable.

Read more about this [here](/customize/application_data/).
Read more about this [here](/customize/vocabularies/).

#### Facets labelling

Expand Down
1 change: 0 additions & 1 deletion theme/frontpage_base.html
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,6 @@
</script>
{% endblock %}
{% block scripts %}
<script src="{{ 'assets/javascripts/bundle.716f8af4.min.js' | url }}"></script>
{% for path in config["extra_javascript"] %}
<script src="{{ path | url }}"></script>
{% endfor %}
Expand Down

0 comments on commit 5cf9bfd

Please sign in to comment.