Skip to content

Commit

Permalink
update generate action name (#354)
Browse files Browse the repository at this point in the history
* update generate action name

* Update README.md

updated readme

Co-authored-by: marqh <mark.hedley@metoffice.gov.uk>
Co-authored-by: Anna Milan <amilan@wmo.int>
  • Loading branch information
3 people authored Nov 2, 2021
1 parent d9023b5 commit 6b8ec9e
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/generateTTLandCommit.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: pre-commit
name: generate-ttl-and-commit

on: pull_request

Expand Down
29 changes: 12 additions & 17 deletions scripts/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,26 @@
## Workflows

there are two github workflows configured for this repository
There are two github workflows configured for this repository.

### Generate TTL and commit

generate TTL and commit runs on the pull request. it creates all `ttl` files from the csv source, then uses git to evaluate which files have changed content. any files which have changed are then placed into a new 1github action commit` and added to the pull request for review.
The generateTTLandCommit.yml runs on the pull request. It creates all `ttl` files from the csv source, then uses git to evaluate which files have changed content. Any files which have changed are then placed into a new github action commit and added to the pull request for review.

### Check consistency

check_consistency runs only when a pull request is merged or the master branch is changed directly
This checks that the contents on the 'test' and 'prod' registers is consistent with the repository
tests can be rerun following managed uppload through the github actions tab
The check_consistency.yml runs only when a pull request is merged or the master branch is changed directly. This checks that the contents on the 'test' and 'prod' registers is consistent with the repository. It is expected to fail when the codes are amended and have not been uploaded to the registry. The tests can be rerun following managed upload through the github actions tab.

## Testing and management
These scripts provides tools written in Python to check content consistency with the published test and prod registers and to upload changes.

scripts provides tools written in Python to check content consistency with the published test and prod registers and to upload changes.

example usage:

* generate `ttl` files and check for existence and consistency against target registry

* generate `ttl` files
```
tmode=test python3 -m scripts.makeWMDREntities
```
tmode=test python -m scripts.check_urls

* check for existence and consistency against target registry
```
tmode=test python3 -m scripts.check_urls
```

* generate `ttl` files and check for existence and consistency against target registry, sending outputs for upload to a named local file
* check for existence and consistency against target registry and send outputs for upload to a named local file

```
tmode=test outfile=</path/to/writeable/file> python3 -m scripts.check_urls
Expand All @@ -42,7 +38,6 @@ python scripts/uploadChanges.py username password test '{"PUT": [],"POST": []}'
python3 -m scripts.uploadChanges <uname> <temporaryKey> test </path/to/a/readable/file>
```


* reset wmdr register on test to match the content of prod

```
Expand Down

0 comments on commit 6b8ec9e

Please sign in to comment.