Skip to content
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

update generate action name #354

Merged
merged 2 commits into from
Nov 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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