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

Check clean-up of schemas & generators at the end of forging #45

Open
jhowlett-scottlogic opened this issue Aug 15, 2022 · 1 comment
Open
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@jhowlett-scottlogic
Copy link
Contributor

Once an API has been forged. The blacksmith needs to ensure that no tools or material are left lying around the forge.

Ensure that all node modules and temporary files are removed so that all that remains after a forging is the requested API files.

Note: when using a NPM package as a generator, ensure that it is removed from the local & global node_modules. At time of writing issue it currently using local node_modules to add npm package generator.

@jhowlett-scottlogic
Copy link
Contributor Author

jhowlett-scottlogic commented Aug 16, 2022

From my current knowledge we have no testing for this repo and the Cucumber feature files are for the language specific generators.

Correct me if I'm wrong.

Should this be done by adding testing to this repo to ensure the generator is working correctly?

Possible tests include:

  • Make sure CL output is correct (verbose and standard)
  • test forge can use generator from GIT URL, file path & npm package
  • test forge can use schema from URL & file path (in both yaml & json formats)
  • test all temporary directories are removed once forging complete.

For the file path schemas/generators, create a setup for the test which takes URL version (of schema/generator) and then save locally to use in testing. Removes the need for local test files in this repo and given we need a test for URL inputs for the other tests it doesn't add any extra dependency on the URLs being valid.

@ColinEberhardt ColinEberhardt added enhancement New feature or request good first issue Good for newcomers labels Aug 16, 2022
jhowlett-scottlogic added a commit that referenced this issue Nov 1, 2022
* ci: add new workflow to update webpages

* ci: add new workflow to update webpages (#30)

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* Add generator webpage (#31)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* docs: Auto-update WEBPAGE.md

* ci: test protected branch

* Add generator webpage (#32)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* ci: test protected branch

* ci: uncomment PAT

* ci add if to all workflows

* ci: use gh-pages branch

* ci: remove duplicate WEBPAGE.md

* ci: fix workflow

* ci: fix artifact upload

* ci: add token

* ci: remove empty line

* Add generator webpage (#39)

* ci: add new workflow to update webpages

* ci: add new workflow to update webpages (#30)

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* Add generator webpage (#31)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* docs: Auto-update WEBPAGE.md

* ci: test protected branch

* Add generator webpage (#32)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* ci: test protected branch

* ci: uncomment PAT

* ci add if to all workflows

* ci: use gh-pages branch

* ci: remove duplicate WEBPAGE.md

* ci: fix workflow

* ci: fix artifact upload

* ci: add token

* ci: remove empty line

Co-authored-by: Jake Howlett <[email protected]>

* d

* Add generator webpage (#40)

* ci: add new workflow to update webpages

* ci: add new workflow to update webpages (#30)

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* Add generator webpage (#31)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* docs: Auto-update WEBPAGE.md

* ci: test protected branch

* Add generator webpage (#32)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* ci: test protected branch

* ci: uncomment PAT

* ci add if to all workflows

* ci: use gh-pages branch

* ci: remove duplicate WEBPAGE.md

* ci: fix workflow

* ci: fix artifact upload

* ci: add token

* ci: remove empty line

* d

Co-authored-by: Jake Howlett <[email protected]>

* add extra push

* Add generator webpage (#41)

* ci: add new workflow to update webpages

* ci: add new workflow to update webpages (#30)

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* Add generator webpage (#31)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* docs: Auto-update WEBPAGE.md

* ci: test protected branch

* Add generator webpage (#32)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* ci: test protected branch

* ci: uncomment PAT

* ci add if to all workflows

* ci: use gh-pages branch

* ci: remove duplicate WEBPAGE.md

* ci: fix workflow

* ci: fix artifact upload

* ci: add token

* ci: remove empty line

* d

* add extra push

Co-authored-by: Jake Howlett <[email protected]>

* ss

* Add generator webpage (#42)

* ci: add new workflow to update webpages

* ci: add new workflow to update webpages (#30)

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* Add generator webpage (#31)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* docs: Auto-update WEBPAGE.md

* ci: test protected branch

* Add generator webpage (#32)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* ci: test protected branch

* ci: uncomment PAT

* ci add if to all workflows

* ci: use gh-pages branch

* ci: remove duplicate WEBPAGE.md

* ci: fix workflow

* ci: fix artifact upload

* ci: add token

* ci: remove empty line

* d

* add extra push

* ss

Co-authored-by: Jake Howlett <[email protected]>

* ff

* Add generator webpage (#43)

* ci: add new workflow to update webpages

* ci: add new workflow to update webpages (#30)

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* Add generator webpage (#31)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* docs: Auto-update WEBPAGE.md

* ci: test protected branch

* Add generator webpage (#32)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* ci: test protected branch

* ci: uncomment PAT

* ci add if to all workflows

* ci: use gh-pages branch

* ci: remove duplicate WEBPAGE.md

* ci: fix workflow

* ci: fix artifact upload

* ci: add token

* ci: remove empty line

* d

* add extra push

* ss

* ff

Co-authored-by: Jake Howlett <[email protected]>

* dd

* Add generator webpage (#44)

* ci: add new workflow to update webpages

* ci: add new workflow to update webpages (#30)

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* Add generator webpage (#31)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* docs: Auto-update WEBPAGE.md

* ci: test protected branch

* Add generator webpage (#32)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* ci: test protected branch

* ci: uncomment PAT

* ci add if to all workflows

* ci: use gh-pages branch

* ci: remove duplicate WEBPAGE.md

* ci: fix workflow

* ci: fix artifact upload

* ci: add token

* ci: remove empty line

* d

* add extra push

* ss

* ff

* dd

Co-authored-by: Jake Howlett <[email protected]>

* dd

* Add generator webpage (#45)

* ci: add new workflow to update webpages

* ci: add new workflow to update webpages (#30)

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* Add generator webpage (#31)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* docs: Auto-update WEBPAGE.md

* ci: test protected branch

* Add generator webpage (#32)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* ci: test protected branch

* ci: uncomment PAT

* ci add if to all workflows

* ci: use gh-pages branch

* ci: remove duplicate WEBPAGE.md

* ci: fix workflow

* ci: fix artifact upload

* ci: add token

* ci: remove empty line

* d

* add extra push

* ss

* ff

* dd

* dd

Co-authored-by: Jake Howlett <[email protected]>

* df

* Add generator webpage (#46)

* ci: add new workflow to update webpages

* ci: add new workflow to update webpages (#30)

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* Add generator webpage (#31)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* docs: Auto-update WEBPAGE.md

* ci: test protected branch

* Add generator webpage (#32)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* ci: test protected branch

* ci: uncomment PAT

* ci add if to all workflows

* ci: use gh-pages branch

* ci: remove duplicate WEBPAGE.md

* ci: fix workflow

* ci: fix artifact upload

* ci: add token

* ci: remove empty line

* d

* add extra push

* ss

* ff

* dd

* dd

* df

Co-authored-by: Jake Howlett <[email protected]>

* dd

* Add generator webpage (#47)

* ci: add new workflow to update webpages

* ci: add new workflow to update webpages (#30)

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* Add generator webpage (#31)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* docs: Auto-update WEBPAGE.md

* ci: test protected branch

* Add generator webpage (#32)

* ci: add new workflow to update webpages

* ci: merge workflow into test.yml

* ci: fix formatting errors

* ci: fix errors after merge

* ci: remove webpage.yml

* ci: test protected branch

* ci: uncomment PAT

* ci add if to all workflows

* ci: use gh-pages branch

* ci: remove duplicate WEBPAGE.md

* ci: fix workflow

* ci: fix artifact upload

* ci: add token

* ci: remove empty line

* d

* add extra push

* ss

* ff

* dd

* dd

* df

* dd

Co-authored-by: Jake Howlett <[email protected]>

* dd

* cc

* dd

* Add line to CONTRIBUTING.md

Co-authored-by: Jake Howlett <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants