Skip to content

Pr2 sample data add workflow#101

Closed
e-lo wants to merge 21 commits into
TIDES-transit:mainfrom
e-lo:pr2-sample-data-add-workflow
Closed

Pr2 sample data add workflow#101
e-lo wants to merge 21 commits into
TIDES-transit:mainfrom
e-lo:pr2-sample-data-add-workflow

Conversation

@e-lo

@e-lo e-lo commented Jan 7, 2023

Copy link
Copy Markdown
Contributor

Pull Request

This PR adds a GitHub workflow for sample validation and associated documentation.

This reflects the splitting up of the original PR reflecting Issue #40 (PR #75) per the suggestion made by @botanize

e-lo added 20 commits September 26, 2022 15:41
Use this instead because it is more configurable/extensible than the redirects.
1. Add example data (imperfect for now) generated by script `create_example` in data/example/data
2. Update validate-data GH action to refer to correct repos.
- Linted
- Auto-generated tabular-data-package datapackage.json from script
- Removed random data and the scripts to generate it, kept csv templates
- Added readmes and documentation about each example in directory
-
- Rendered samples as a table w/out readmes
- Renamed data folders to samples and TIDES
- Added metadata to datapackage.json about vendors, github handles, NTDID, agency name and exposed in documentation
- Updated documentation for consistency
- Renamed 'example' to 'template' to be more consistent with what it is
- changed workflow title to fix link with spaces
- moved datapackage.json up one directory, updated docs, updated source refs
- added missing --schema flag
- Removes refs to template
- Removes refs to github workflows
- and updates documentation
@e-lo e-lo added the 💻 code Pertains to the infrastructure code label Jan 7, 2023
@e-lo e-lo requested a review from botanize January 7, 2023 21:30
@e-lo e-lo self-assigned this Jan 7, 2023

@botanize botanize left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  • Remove all files except validate_samples.yml
  • we need --schema-sync flag for the frictionless validator

Comment thread .github/workflows/validate_samples.yml Outdated
Comment on lines +6 to +11
- 'data/*/TIDES/*'
- 'spec/*'
pull_request:
paths:
- 'data/*/TIDES/*'
- 'spec/*'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think data/*/TIDES/* needs to be samples/*/TIDES/*

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Remove all files except validate_samples.yml

Not sure why? this is just tiering off of other files that are already there - shouldn't be adding anything else.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This PR makes changes also proposed in #100, but should be independent or "stacked" on that PR, otherwise you'll be resolving merge conflicts when trying to merge this PR. Additionally, all files except validate_samples.yml are irrelevant to the purpose of this PR!

Comment thread .github/workflows/validate_samples.yml Outdated
- name: Validate data
uses: frictionlessdata/repository@v2
with:
packages: "data/*/TIDES/datapackage.json"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

data => samples, e.g., samples/*/TIDES/datapackage.json

- name: Checkout repository
uses: actions/checkout@v2
- name: Validate data
uses: frictionlessdata/repository@v2

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is there any way to pass --schema-sync to this action? Otherwise it will fail when option fields are left out of the csvs.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

looking into it

@e-lo

e-lo commented Feb 1, 2023

Copy link
Copy Markdown
Contributor Author

Replaced by: #104

@e-lo e-lo deleted the pr2-sample-data-add-workflow branch February 1, 2023 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

💻 code Pertains to the infrastructure code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants