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.

Sign up for GitHub

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

Jump to bottom

feat: add docs:single #529

Merged
merged 7 commits into from
Jul 1, 2022
Merged

feat: add docs:single #529

merged 7 commits into from
Jul 1, 2022

Conversation

garrett-wade
Copy link
Contributor

@garrett-wade garrett-wade commented Jun 27, 2022 •
edited
Loading

🚥 Fix RM-XXX

🧰 Changes

  • add doc:create command to allow a single markdown file to be synced rather than only supporting an entire directory.
  • updated markdown and doc test to reflect changes

🧬 QA & Testing

The doc:create command can be ran with the --filepath attribute being set to a specific markdown file-path and that file will be synced. If the slug already exists then the chance will not be merged.

@erunion erunion added the enhancement New feature or request label Jun 27, 2022
@erunion erunion requested review from a team, erunion, Dashron and kanadgupta and removed request for a team June 27, 2022 22:34
@erunion erunion changed the title add doc:create feat: add doc:create Jun 27, 2022
kanadgupta
kanadgupta requested changes Jun 28, 2022
View reviewed changes
Copy link
Member

@kanadgupta kanadgupta left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @garrett-wade! I still have yet to do a full review but do you mind adding dry run functionality for this command? Ideally we should have feature parity with the main docs command.

@kanadgupta kanadgupta self-requested a review June 28, 2022 00:20
@garrett-wade
Copy link
Contributor Author

@kanadgupta added dry run support

@garrett-wade
Copy link
Contributor Author

@kanadgupta or @erunion just following up on this PR, in case you have had a change to review further. Thank you.

erunion
erunion reviewed Jun 30, 2022
View reviewed changes
src/cmds/docs/create.js Outdated Show resolved Hide resolved
kanadgupta
kanadgupta requested changes Jun 30, 2022
View reviewed changes
Copy link
Member

@kanadgupta kanadgupta left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Can you rename this command as described below? And could you merge the main branch into this branch? I just merged in #531 which should hopefully get tests running on this PR properly. (edit: never mind I took care of refreshing the branch!)

src/cmds/docs/create.js Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@kanadgupta
Copy link
Member

Ignore the failing GitHub Action Dry Run workflow, I believe that's because your fork doesn't have the API key secrets configured.

@kanadgupta kanadgupta self-requested a review June 30, 2022 17:51
@garrett-wade
Copy link
Contributor Author

@kanadgupta updates made.

@kanadgupta kanadgupta changed the title feat: add doc:create feat: add docs:single Jul 1, 2022
kanadgupta
kanadgupta approved these changes Jul 1, 2022
View reviewed changes
Copy link
Member

@kanadgupta kanadgupta left a comment

Choose a reason for hiding this comment

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

Thanks @garrett-wade!

@kanadgupta kanadgupta requested a review from erunion July 1, 2022 15:54
erunion
erunion approved these changes Jul 1, 2022
View reviewed changes
Copy link
Member

@erunion erunion left a comment

Choose a reason for hiding this comment

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

thanks @garrett-wade!

@erunion erunion merged commit 01eb66d into readmeio:main Jul 1, 2022
@kanadgupta kanadgupta mentioned this pull request Jul 21, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kanadgupta kanadgupta kanadgupta approved these changes

@erunion erunion erunion approved these changes

@Dashron Dashron Awaiting requested review from Dashron Dashron was automatically assigned from readmeio/api-tooling

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@garrett-wade @kanadgupta @erunion