Skip to content

Include md files from MarkdownFiles Directory field when publishing #13577

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
Merged
QilongTang merged 4 commits into from
Nov 30, 2022
Merged

Include md files from MarkdownFiles Directory field when publishing #13577

QilongTang merged 4 commits into from
Nov 30, 2022

Conversation

@QilongTang
Copy link
Contributor

@QilongTang QilongTang commented Nov 29, 2022 •
edited
Loading

Please Note:

  1. Before submitting the PR, please review How to Contribute to Dynamo
  2. Dynamo Team will meet 1x a month to review PRs found on Github (Issues will be handled separately)
  3. PRs will be reviewed from oldest to newest
  4. If a reviewed PR requires changes by the owner, the owner of the PR has 30 days to respond. If the PR has seen no activity by the next session, it will be either closed by the team or depending on its utility will be taken over by someone on the team
  5. PRs should use either Dynamo's default PR template or one of these other template options in order to be considered for review.
  6. PRs that do not have one of the Dynamo PR templates completely filled out with all declarations satisfied will not be reviewed by the Dynamo team.
  7. PRs made to the DynamoRevit repo will need to be cherry-picked into all the DynamoRevit Release branches that Dynamo supports. Contributors will be responsible for cherry-picking their reviewed commits to the other branches after a LGTM label is added to the PR.

Purpose

Per https://jira.autodesk.com/browse/DYN-5447, when publishing the current package, include Markdown files from MarkdownFiles Directory field.

Declarations

Check these if you believe they are true

  • The codebase is in a better state after this PR
  • Is documented according to the standards
  • The level of testing this PR includes is appropriate
  • User facing strings, if any, are extracted into *.resx files
  • All tests pass using the self-service CI.
  • Snapshot of UI changes, if any.
  • Changes to the API follow Semantic Versioning and are documented in the API Changes document.
  • This PR modifies some build requirements and the readme is updated

Release Notes

Include md files from MarkdownFiles Directory field when publishing

Reviewers

@DynamoDS/dynamo

FYIs

(FILL ME IN, Optional) Names of anyone else you wish to be notified of

@mjkkirschner
Copy link
Member

mjkkirschner commented Nov 29, 2022

one real failing test:
https://master-5.jenkins.autodesk.com/job/Dynamo/job/DynamoSelfServe/job/pullRequestValidation/7808/testReport/junit/DynamoCoreWpfTests/PublishPackageViewModelTests/CanPublishLateInitializedJsonCustomNode/

@QilongTang QilongTang added this to the 2.17.0 milestone Nov 29, 2022
@QilongTang
Copy link
Contributor Author

QilongTang commented Nov 29, 2022 •
edited
Loading

one real failing test: https://master-5.jenkins.autodesk.com/job/Dynamo/job/DynamoSelfServe/job/pullRequestValidation/7808/testReport/junit/DynamoCoreWpfTests/PublishPackageViewModelTests/CanPublishLateInitializedJsonCustomNode/

Updated, PTAL. Tested locally that unit test pass and the md files under optional dir is copied to docs folder when publishing

@mjkkirschner
Copy link
Member

mjkkirschner commented Nov 29, 2022

If you have time it would be good to update the package builder tests to add tests for the docs folder.

@QilongTang
Copy link
Contributor Author

QilongTang commented Nov 30, 2022

If you have time it would be good to update the package builder tests to add tests for the docs folder.

Sure. Done

@QilongTang QilongTang merged commit 3cb7f80 into master Nov 30, 2022
@QilongTang QilongTang deleted the IncludeMarkdownFiles branch November 30, 2022 08:03
QilongTang added a commit that referenced this pull request Nov 30, 2022
@QilongTang
Include md files from MarkdownFiles Directory field when publishing (#…
627f8b9 
…13577)

* Include Markdown files as package content

* Update

* Update

* Add unit test
@QilongTang QilongTang mentioned this pull request Nov 30, 2022
Merged
8 tasks
QilongTang added a commit that referenced this pull request Nov 30, 2022
@QilongTang
Include md files from MarkdownFiles Directory field when publishing (#…
1c6e6cb 
…13577) (#13584)

* Include Markdown files as package content

* Update

* Update

* Add unit test
@QilongTang QilongTang mentioned this pull request Dec 6, 2022
Merged
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mjkkirschner mjkkirschner mjkkirschner approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

2.17.0

Development

Successfully merging this pull request may close these issues.

3 participants

@QilongTang @mjkkirschner