This repository was archived by the owner on Sep 14, 2021. It is now read-only.
feat(dart_doc_syncer): sync selected projects and other improvements #13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
Thanks for the PR! I'll review this one tomorrow as I don't have much time today. |
chalin
force-pushed
the
chalin-new-sync-all-option-0604
branch
from
3df7c22 to
966b971
Compare
While maintain the ability to sync a single project by name, this commit obviates the need to maintain a list of examples to sync. Now dart_doc_syncer considers any example project with a doc syncer data file (`.docsync.json`) as a potential candidate for syncing. Multiple projects can be synced at a time by use of the `--match <path-regexp>` command-line option. Other changes: - Dry-run no longer forces verbosity. - Updates to README.md file generation. - docsync.json "schema" has changed: - `name` is now taken to represent the example folder name; e.g., 'architecture'; it is omitted from the data file since its value can be derived. - Added `title`, e.g. 'Architecture Overview'. - Added `docPart`, e.g. 'guide' (from 'guide/architecture'). - `docHref` and `liveExampleHref` can now be relative URIs. - New command-line flags (see command help for details): - An ng.io branch other than master can be specified. - `--keep-tmp`, `--no-push`. - Tmp directory is set to ~/tmp if it exists instead of the script bin folder. Note, the behavior of `sync_add` has not be changed.
chalin
force-pushed
the
chalin-new-sync-all-option-0604
branch
from
966b971 to
6e4d6f4
Compare
Contributor
Author
|
Any update on this? |
Contributor
|
I'll merge it as is, it's awesome! Nit: It would be easier to review if you split this into mutliple PRs next time. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While maintain the ability to sync a single project by name, this commit obviates the need to maintain a list of examples to sync. Now dart_doc_syncer considers any example project with a doc syncer data file (
.docsync.json) as a potential candidate for syncing.Multiple projects can be synced at a time by use of the
--match <path-regexp>command-line option.Other changes:
SyncDataclass have changed:nameis now taken to represent the example folder name; e.g.,'architecture'; it is omitted from the data file since its value can be
derived.
title, e.g. 'Architecture Overview'.docPart, e.g. 'guide' (from 'guide/architecture').docHrefandliveExampleHrefcan now be relative URIs.--force-buildto change this default behavior.mastercan be specified.--keep-tmp,--no-push,--force-build~/tmpor/tmpif possible, otherwise fallback to script binfolder.
Note, the behavior of
sync_addhas not be changed.