Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

chore: Ignore markdown files and GitHub workflows in Docker and Go wo… #1565

Merged
merged 1 commit into from
Sep 12, 2024

Conversation

dwertent
Copy link
Contributor

This will prevent unnecessary tests from running when changes are made to the markdown files.
Here is an example: https://github.com/hyperledger/firefly/actions/runs/10594695480

@dwertent dwertent requested a review from a team as a code owner August 28, 2024 19:55
pull_request:
branches: [main]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't see a reason to limit the tests to only run when a PR is opened against the main branch. Removing this restriction will enable the development of feature branches and opening PRs against them.

Copy link
Contributor

@EnriqueL8 EnriqueL8 left a comment

Choose a reason for hiding this comment

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

We need the test to run for these

func TestCheckGeneratedMarkdownPages(t *testing.T) {
to validate that the Markdown generated is correct based on the code annotations

.github/workflows/docker_main.yml Outdated Show resolved Hide resolved
Copy link

codecov bot commented Sep 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (a983877) to head (e873d29).
Report is 13 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1565   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          325       325           
  Lines        24049     24055    +6     
=========================================
+ Hits         24049     24055    +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dwertent dwertent requested a review from EnriqueL8 September 6, 2024 14:41
…rkflows

Signed-off-by: dwertent <david.wertenteil@kaleido.io>
Copy link
Contributor

@EnriqueL8 EnriqueL8 left a comment

Choose a reason for hiding this comment

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

Didn't finish my previous review that we discussed

@@ -3,8 +3,11 @@ name: Go
on:
push:
branches: [main]
paths-ignore:
- '**.md'
Copy link
Contributor

Choose a reason for hiding this comment

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

Add this line as we want the tests to run to verify the reference

- 'doc-site/docs/reference/**.md' # include markdown files that are auto generated and need to be tested

Copy link
Contributor

@EnriqueL8 EnriqueL8 left a comment

Choose a reason for hiding this comment

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

looks good

@EnriqueL8 EnriqueL8 merged commit 0ab3df9 into hyperledger:main Sep 12, 2024
2 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants