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

Readme generator could exclude some files #1139

Closed
wants to merge 8 commits into from

Conversation

crazygao
Copy link
Contributor

@crazygao crazygao commented Nov 15, 2023

Description

generate Readme could exclude some files,
will exclude examples/flows/integrations from readme generation.

All Promptflow Contribution checklist:

  • The pull request does not introduce [breaking changes].
  • CHANGELOG is updated for new features, bug fixes or other
    significant changes.
  • I have read the contribution guidelines.
  • Create an issue and link to the pull request to get dedicated
    review from promptflow team. Learn more: suggested
    workflow
    .

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an
    informative message. This means that previously merged commits do not
    appear in the history of the PR. For more information on cleaning up the
    commits in your PR, see this
    page
    .

Testing Guidelines

  • Pull request includes test coverage for the included changes.

Signed-off-by: Brynn Yin [email protected]
Co-authored-by: Zhengfei Wang [email protected]

Description

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

All Promptflow Contribution checklist:

  • The pull request does not introduce [breaking changes].
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.
  • Create an issue and link to the pull request to get dedicated review from promptflow team. Learn more: suggested workflow.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

# Description

generate Readme could exclude some files

# All Promptflow Contribution checklist:
- [ ] **The pull request does not introduce [breaking changes].**
- [ ] **CHANGELOG is updated for new features, bug fixes or other
significant changes.**
- [ ] **I have read the [contribution guidelines](../CONTRIBUTING.md).**
- [ ] **Create an issue and link to the pull request to get dedicated
review from promptflow team. Learn more: [suggested
workflow](../CONTRIBUTING.md#suggested-workflow).**

## General Guidelines and Best Practices
- [ ] Title of the pull request is clear and informative.
- [ ] There are a small number of commits, each of which have an
informative message. This means that previously merged commits do not
appear in the history of the PR. For more information on cleaning up the
commits in your PR, [see this
page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md).

### Testing Guidelines
- [ ] Pull request includes test coverage for the included changes.

---------

Signed-off-by: Brynn Yin <[email protected]>
Co-authored-by: Zhengfei Wang <[email protected]>

# Description

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

# All Promptflow Contribution checklist:
- [ ] **The pull request does not introduce [breaking changes].**
- [ ] **CHANGELOG is updated for new features, bug fixes or other significant changes.**
- [ ] **I have read the [contribution guidelines](../CONTRIBUTING.md).**
- [ ] **Create an issue and link to the pull request to get dedicated review from promptflow team. Learn more: [suggested workflow](../CONTRIBUTING.md#suggested-workflow).**

## General Guidelines and Best Practices
- [ ] Title of the pull request is clear and informative.
- [ ] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, [see this page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md).

### Testing Guidelines
- [ ] Pull request includes test coverage for the included changes.
Copy link

github-actions bot commented Nov 15, 2023

SDK CLI Global Config Test Result yigao/fix_readme_exclude

2 tests   2 ✔️  48s ⏱️
1 suites  0 💤
1 files    0

Results for commit 5760c26.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Nov 15, 2023

promptflow SDK CLI Azure Unit Test Result yigao/fix_readme_exclude

  2 files    2 suites   47s ⏱️
32 tests 30 ✔️ 2 💤 0
64 runs  60 ✔️ 4 💤 0

Results for commit dd104a1.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Nov 15, 2023

Executor Unit Test Result yigao/fix_readme_exclude

557 tests   557 ✔️  48s ⏱️
    1 suites      0 💤
    1 files        0

Results for commit 5760c26.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Nov 15, 2023

promptflow SDK CLI Azure E2E Test Result yigao/fix_readme_exclude

    2 files    2 suites   1m 8s ⏱️
  57 tests 36 ✔️ 21 💤 0
114 runs  72 ✔️ 42 💤 0

Results for commit ebb5d68.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Nov 15, 2023

Executor E2E Test Result yigao/fix_readme_exclude

142 tests   138 ✔️  2m 0s ⏱️
    1 suites      4 💤
    1 files        0

Results for commit dd104a1.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Nov 15, 2023

SDK PFS E2E Test Result yigao/fix_readme_exclude

  2 files    2 suites   58s ⏱️
  9 tests   9 ✔️ 0 💤 0
18 runs  18 ✔️ 0 💤 0

Results for commit dd104a1.

♻️ This comment has been updated with latest results.

@crazygao crazygao changed the title generate Readme could exclude some files Readme generator could exclude some files Nov 15, 2023
Copy link

SDK CLI Test Result yigao/fix_readme_exclude

350 tests   337 ✔️  12m 34s ⏱️
    1 suites    13 💤
    1 files        0

Results for commit dd104a1.

D-W- and others added 4 commits November 15, 2023 03:19
# Description

Please add an informative description that covers that changes made by
the pull request and link all relevant issues.

# All Promptflow Contribution checklist:
- [ ] **The pull request does not introduce [breaking changes].**
- [ ] **CHANGELOG is updated for new features, bug fixes or other
significant changes.**
- [ ] **I have read the [contribution guidelines](../CONTRIBUTING.md).**
- [ ] **Create an issue and link to the pull request to get dedicated
review from promptflow team. Learn more: [suggested
workflow](../CONTRIBUTING.md#suggested-workflow).**

## General Guidelines and Best Practices
- [ ] Title of the pull request is clear and informative.
- [ ] There are a small number of commits, each of which have an
informative message. This means that previously merged commits do not
appear in the history of the PR. For more information on cleaning up the
commits in your PR, [see this
page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md).

### Testing Guidelines
- [ ] Pull request includes test coverage for the included changes.
# Description

Please add an informative description that covers that changes made by
the pull request and link all relevant issues.

# All Promptflow Contribution checklist:
- [ ] **The pull request does not introduce [breaking changes].**
- [ ] **CHANGELOG is updated for new features, bug fixes or other
significant changes.**
- [ ] **I have read the [contribution guidelines](../CONTRIBUTING.md).**
- [ ] **Create an issue and link to the pull request to get dedicated
review from promptflow team. Learn more: [suggested
workflow](../CONTRIBUTING.md#suggested-workflow).**

## General Guidelines and Best Practices
- [ ] Title of the pull request is clear and informative.
- [ ] There are a small number of commits, each of which have an
informative message. This means that previously merged commits do not
appear in the history of the PR. For more information on cleaning up the
commits in your PR, [see this
page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md).

### Testing Guidelines
- [ ] Pull request includes test coverage for the included changes.
Update the doc to introduce cloud value

# Description

Please add an informative description that covers that changes made by
the pull request and link all relevant issues.

# All Promptflow Contribution checklist:
- [ ] **The pull request does not introduce [breaking changes].**
- [ ] **CHANGELOG is updated for new features, bug fixes or other
significant changes.**
- [ ] **I have read the [contribution guidelines](../CONTRIBUTING.md).**
- [ ] **Create an issue and link to the pull request to get dedicated
review from promptflow team. Learn more: [suggested
workflow](../CONTRIBUTING.md#suggested-workflow).**

## General Guidelines and Best Practices
- [ ] Title of the pull request is clear and informative.
- [ ] There are a small number of commits, each of which have an
informative message. This means that previously merged commits do not
appear in the history of the PR. For more information on cleaning up the
commits in your PR, [see this
page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md).

### Testing Guidelines
- [ ] Pull request includes test coverage for the included changes.
@github-actions github-actions bot added documentation Improvements or additions to documentation examples Improvements on examples sdk prompt flow SDK promptflow labels Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation examples Improvements on examples fundamental promptflow sdk prompt flow SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants